XMPP Class

Properties   Methods   Events   Config Settings   Errors  

The XMPP Class is used to create a lightweight messaging client using the XMPP (Jabber) protocol.

Syntax

XMPP

Remarks

The XMPP class supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method.

A call to the ConnectTo method will perform the entire logon process after which a Connected event will fire to indicate the connection status. For simplicity, the entire interface is synchronous; the class will not return until a call is completed.

After a successful connection, the class will automatically begin the process of receiving the user's buddy list. The class will parse the XML as it comes in from the server and will set the appropriate properties. Once the entire buddy list has been retrieved, a Sync event will fire.

Sending a message is as simple as calling a single method. One call to the SendMessage method will cause the class to connect if it has not already done so, send the specified message to a specified user, and return to the original connection state.

The XMPP Class interface supports messaging, list, and presence management. Other features of the XMPP protocol are supported through the SendCommand method and PITrail event.

Example 1. Connecting and Sending a Message:

IMControl.ConnectTo("myusername", "mypassword") IMControl.MessageText = "My Message" IMControl.SendMessage("ToUser") Example 2. Sending a Single Message:

IMControl.User = "myusername" IMControl.Password = "mypassword" IMControl.MessageText = "My Message" IMControl.SendMessage("ToUser")

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

AuthDomain Property (XMPP Class)

This property includes the domain under which the user will be authenticated.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthDomain();
int SetAuthDomain(const char* lpszAuthDomain);

Unicode (Windows)
LPWSTR GetAuthDomain();
INT SetAuthDomain(LPCWSTR lpszAuthDomain);

char* ipworksmq_xmpp_getauthdomain(void* lpObj);
int ipworksmq_xmpp_setauthdomain(void* lpObj, const char* lpszAuthDomain);

QString GetAuthDomain();
int SetAuthDomain(QString qsAuthDomain);

Default Value

""

Remarks

Set this value if the user must authenticate through a third-party authentication service that requires a different domain than the XMPP user's registered domain.

Data Type

String

AuthMethods Property (XMPP Class)

This property controls how the class authenticates itself with the XMPP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthMethods();
int SetAuthMethods(const char* lpszAuthMethods);

Unicode (Windows)
LPWSTR GetAuthMethods();
INT SetAuthMethods(LPCWSTR lpszAuthMethods);

char* ipworksmq_xmpp_getauthmethods(void* lpObj);
int ipworksmq_xmpp_setauthmethods(void* lpObj, const char* lpszAuthMethods);

QString GetAuthMethods();
int SetAuthMethods(QString qsAuthMethods);

Default Value

"*"

Remarks

AuthMethods is a comma-separated list of authentication methods to be enabled on the class, listed in order of preference. When authenticating, the class will pick the first method in the list that is supported by the server.

The special value * (default) may be supplied to cause the class to enable all supported authentication methods in order of presumed security. The XMPP class currently supports the following values for AuthMethods, listed in order of most secure to least secure:

• SASL/DIGEST-MD5
• AuthIQ/Digest
• SASL/CRAM-MD5
• SASL/PLAIN
• AuthIQ/Plaintext
• SASL/NTLM

Data Type

String

Buddies Property (XMPP Class)

This property includes a collection of buddies in the buddy list.

Syntax

• C++
• C
• Qt

IPWorksMQList<IPWorksMQXMPPBuddy>* GetBuddies();

int ipworksmq_xmpp_getbuddycount(void* lpObj);

char* ipworksmq_xmpp_getbuddygroup(void* lpObj, int buddyindex);

char* ipworksmq_xmpp_getbuddyid(void* lpObj, int buddyindex);

char* ipworksmq_xmpp_getbuddynickname(void* lpObj, int buddyindex);
int ipworksmq_xmpp_setbuddynickname(void* lpObj, int buddyindex, const char* lpszBuddyNickName);

char* ipworksmq_xmpp_getbuddyrealname(void* lpObj, int buddyindex);

int ipworksmq_xmpp_getbuddysubscription(void* lpObj, int buddyindex);

int GetBuddyCount();

QString GetBuddyGroup(int iBuddyIndex);

QString GetBuddyId(int iBuddyIndex);

QString GetBuddyNickName(int iBuddyIndex);
int SetBuddyNickName(int iBuddyIndex, QString qsBuddyNickName);

QString GetBuddyRealName(int iBuddyIndex);

int GetBuddySubscription(int iBuddyIndex);

Remarks

After a Sync event is fired, this property will contain a collection of all buddies in the buddy list. The buddy list will be updated by the server when a successful call to RetrieveRoster has been made.

This property is read-only.

Data Type

IPWorksMQXMPPBuddy

Connected Property (XMPP Class)

This property indicates whether the class is connected and logged in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();

Unicode (Windows)
BOOL GetConnected();

int ipworksmq_xmpp_getconnected(void* lpObj);

bool GetConnected();

Default Value

FALSE

Remarks

This property indicates whether the class is connected and logged in to the remote host. Use the Connect and Disconnect methods to manage the connection.

This property is read-only and not available at design time.

Data Type

Boolean

Firewall Property (XMPP Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

IPWorksMQFirewall* GetFirewall();
int SetFirewall(IPWorksMQFirewall* val);

int ipworksmq_xmpp_getfirewallautodetect(void* lpObj);
int ipworksmq_xmpp_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int ipworksmq_xmpp_getfirewalltype(void* lpObj);
int ipworksmq_xmpp_setfirewalltype(void* lpObj, int iFirewallType);

char* ipworksmq_xmpp_getfirewallhost(void* lpObj);
int ipworksmq_xmpp_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* ipworksmq_xmpp_getfirewallpassword(void* lpObj);
int ipworksmq_xmpp_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int ipworksmq_xmpp_getfirewallport(void* lpObj);
int ipworksmq_xmpp_setfirewallport(void* lpObj, int iFirewallPort);

char* ipworksmq_xmpp_getfirewalluser(void* lpObj);
int ipworksmq_xmpp_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Data Type

IPWorksMQFirewall

IMPort Property (XMPP Class)

This property includes the server port for XMPP (default 5222).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIMPort();
int SetIMPort(int iIMPort);

Unicode (Windows)
INT GetIMPort();
INT SetIMPort(INT iIMPort);

int ipworksmq_xmpp_getimport(void* lpObj);
int ipworksmq_xmpp_setimport(void* lpObj, int iIMPort);

int GetIMPort();
int SetIMPort(int iIMPort);

Default Value

5222

Remarks

For an implicit Secure Sockets Layer (SSL), use port 5223. For more information, please refer to the SSLStartMode property.

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

Data Type

Integer

IMServer Property (XMPP Class)

This property is the instant messaging server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetIMServer();
int SetIMServer(const char* lpszIMServer);

Unicode (Windows)
LPWSTR GetIMServer();
INT SetIMServer(LPCWSTR lpszIMServer);

char* ipworksmq_xmpp_getimserver(void* lpObj);
int ipworksmq_xmpp_setimserver(void* lpObj, const char* lpszIMServer);

QString GetIMServer();
int SetIMServer(QString qsIMServer);

Default Value

""

Remarks

This is the instant messaging server to which the class will connect when the Connect method is called. The IMServer property must contain a valid XMPP (Jabber) server, or any subsequent calls to the Connect method will fail.

Data Type

String

LocalDirectory Property (XMPP Class)

This property includes the directory to which received files are saved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalDirectory();
int SetLocalDirectory(const char* lpszLocalDirectory);

Unicode (Windows)
LPWSTR GetLocalDirectory();
INT SetLocalDirectory(LPCWSTR lpszLocalDirectory);

char* ipworksmq_xmpp_getlocaldirectory(void* lpObj);
int ipworksmq_xmpp_setlocaldirectory(void* lpObj, const char* lpszLocalDirectory);

QString GetLocalDirectory();
int SetLocalDirectory(QString qsLocalDirectory);

Default Value

""

Remarks

This property specifies the directory on disk to which received files will be saved. If this property is not set and a file is received, the file data will be available through the Transfer event parameters. This property may also be set when the StartTransfer event fires.

Data Type

String

LocalFile Property (XMPP Class)

This property includes the path to the file that will be sent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalFile();
int SetLocalFile(const char* lpszLocalFile);

Unicode (Windows)
LPWSTR GetLocalFile();
INT SetLocalFile(LPCWSTR lpszLocalFile);

char* ipworksmq_xmpp_getlocalfile(void* lpObj);
int ipworksmq_xmpp_setlocalfile(void* lpObj, const char* lpszLocalFile);

QString GetLocalFile();
int SetLocalFile(QString qsLocalFile);

Default Value

""

Remarks

This property specifies the local file that will be sent when calling SendFile. This property must be set before calling SendFile.

Data Type

String

LocalHost Property (XMPP Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworksmq_xmpp_getlocalhost(void* lpObj);
int ipworksmq_xmpp_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

MessageHTML Property (XMPP Class)

This property includes the HTML version of the current message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageHTML();
int SetMessageHTML(const char* lpszMessageHTML);

Unicode (Windows)
LPWSTR GetMessageHTML();
INT SetMessageHTML(LPCWSTR lpszMessageHTML);

char* ipworksmq_xmpp_getmessagehtml(void* lpObj);
int ipworksmq_xmpp_setmessagehtml(void* lpObj, const char* lpszMessageHTML);

QString GetMessageHTML();
int SetMessageHTML(QString qsMessageHTML);

Default Value

""

Remarks

If the user wishes to send any HTML as a part of the message, it must be set in the MessageHTML property. The HTML must be an entire HTML document, including the <html> and <body> tags. If the HTML has unbalanced tags, the XMPP class will fail with an error.

This property is not available at design time.

Data Type

String

MessageOtherData Property (XMPP Class)

This property contains extra data elements for the current message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageOtherData();
int SetMessageOtherData(const char* lpszMessageOtherData);

Unicode (Windows)
LPWSTR GetMessageOtherData();
INT SetMessageOtherData(LPCWSTR lpszMessageOtherData);

char* ipworksmq_xmpp_getmessageotherdata(void* lpObj);
int ipworksmq_xmpp_setmessageotherdata(void* lpObj, const char* lpszMessageOtherData);

QString GetMessageOtherData();
int SetMessageOtherData(QString qsMessageOtherData);

Default Value

""

Remarks

MessageOtherData will contain zero or more complete XML elements that are associated with the message but that are not defined in the Jabber specification.

Data Type

String

MessageSubject Property (XMPP Class)

This property is the subject of the current message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageSubject();
int SetMessageSubject(const char* lpszMessageSubject);

Unicode (Windows)
LPWSTR GetMessageSubject();
INT SetMessageSubject(LPCWSTR lpszMessageSubject);

char* ipworksmq_xmpp_getmessagesubject(void* lpObj);
int ipworksmq_xmpp_setmessagesubject(void* lpObj, const char* lpszMessageSubject);

QString GetMessageSubject();
int SetMessageSubject(QString qsMessageSubject);

Default Value

""

Remarks

MessageSubject will contain any subject associated with the message. Most Jabber clients will ignore the subject unless the message is of type "headline".

This property is not available at design time.

Data Type

String

MessageText Property (XMPP Class)

This property is the plaintext version of the current message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageText();
int SetMessageText(const char* lpszMessageText);

Unicode (Windows)
LPWSTR GetMessageText();
INT SetMessageText(LPCWSTR lpszMessageText);

char* ipworksmq_xmpp_getmessagetext(void* lpObj);
int ipworksmq_xmpp_setmessagetext(void* lpObj, const char* lpszMessageText);

QString GetMessageText();
int SetMessageText(QString qsMessageText);

Default Value

""

Remarks

MessageText is the plaintext version of the current message, taken from the message's "body" child element. The text in this property is automatically escaped to ensure valid XML parsing on the other end.

This property is not available at design time.

Data Type

String

MessageThread Property (XMPP Class)

This property is the thread name of the current message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageThread();
int SetMessageThread(const char* lpszMessageThread);

Unicode (Windows)
LPWSTR GetMessageThread();
INT SetMessageThread(LPCWSTR lpszMessageThread);

char* ipworksmq_xmpp_getmessagethread(void* lpObj);
int ipworksmq_xmpp_setmessagethread(void* lpObj, const char* lpszMessageThread);

QString GetMessageThread();
int SetMessageThread(QString qsMessageThread);

Default Value

""

Remarks

MessageThread will contain the name of the thread associated with the message. Threads are useful for tracking messages of type "chat" or "groupchat".

This property is not available at design time.

Data Type

String

MessageType Property (XMPP Class)

This property is the type of the current message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageType();
int SetMessageType(int iMessageType);

Unicode (Windows)
INT GetMessageType();
INT SetMessageType(INT iMessageType);

JMT_NORMAL(0), 
JMT_CHAT(1), 
JMT_GROUP_CHAT(2), 
JMT_HEADLINE(3), 
JMT_ERROR(4)

int ipworksmq_xmpp_getmessagetype(void* lpObj);
int ipworksmq_xmpp_setmessagetype(void* lpObj, int iMessageType);

int GetMessageType();
int SetMessageType(int iMessageType);

Default Value

0

Remarks

MessageType is the type of the message as specified in the XMPP RFC. The possible values are defined in the protocol specification as follows:

This property is not available at design time.

Data Type

Integer

Password Property (XMPP Class)

This property is the user's password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* ipworksmq_xmpp_getpassword(void* lpObj);
int ipworksmq_xmpp_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

""

Remarks

This property must be set before a connection is attempted. If a call to the Connect method is made specifying a password, then the Password property will contain that password.

Data Type

String

Presence Property (XMPP Class)

This property indicates the availability of the entity.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPresence();

Unicode (Windows)
INT GetPresence();

PC_OFFLINE(0), 
PC_CHAT(1), 
PC_AWAY(2), 
PC_XA(3), 
PC_DND(4)

int ipworksmq_xmpp_getpresence(void* lpObj);

int GetPresence();

Default Value

1

Remarks

When the class completes the initial login, it will send information telling other entities subscribed to this entity's presence that it is online.

The Presence property has one of four values representing general information about the user's status as defined in the Jabber protocol specification:

By default, the class sets the client presence to pcChat, meaning that the user is available.

Note: Offline is not officially supported by the XMPP specification; however, some XMPP server implementations may recognize the value. Setting the client's presence state to this value may cause the server to respond with an Error.

The Status property is a pure-text string representing the user's presence information. Its value maybe be any random string, including the empty string, "".

If the application or user wishes to associate a specific status message with a new presence value, it should use the ChangePresence method. ChangePresence will update both the Presence and Status properties, and then send that information to the server.

This property is read-only and not available at design time.

Data Type

Integer

Resource Property (XMPP Class)

This property is the resource for the current session.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResource();
int SetResource(const char* lpszResource);

Unicode (Windows)
LPWSTR GetResource();
INT SetResource(LPCWSTR lpszResource);

char* ipworksmq_xmpp_getresource(void* lpObj);
int ipworksmq_xmpp_setresource(void* lpObj, const char* lpszResource);

QString GetResource();
int SetResource(QString qsResource);

Default Value

"IPWorks XMPP Agent"

Remarks

Whenever an entity logs in to an XMPP (Jabber) server, it must provide account information as well as a resource. Resources allow multiple clients to log in using the same account. The server will forward all messages and PI data aimed at a specific resource to that resource. If a command or message is to be sent to a Jabber Id with no specified resource, the server will push that command or message out to all connected resources.

Data Type

String

ServerDomain Property (XMPP Class)

This property includes the XMPP server's domain.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerDomain();
int SetServerDomain(const char* lpszServerDomain);

Unicode (Windows)
LPWSTR GetServerDomain();
INT SetServerDomain(LPCWSTR lpszServerDomain);

char* ipworksmq_xmpp_getserverdomain(void* lpObj);
int ipworksmq_xmpp_setserverdomain(void* lpObj, const char* lpszServerDomain);

QString GetServerDomain();
int SetServerDomain(QString qsServerDomain);

Default Value

""

Remarks

The domain of the XMPP server itself. Set this value if the domain of the server is different from the DNS name of the IMServer.

Data Type

String

SSLAcceptServerCert Property (XMPP Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C++
• C
• Qt

IPWorksMQCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(IPWorksMQCertificate* val);

char* ipworksmq_xmpp_getsslacceptservercerteffectivedate(void* lpObj);

char* ipworksmq_xmpp_getsslacceptservercertexpirationdate(void* lpObj);

char* ipworksmq_xmpp_getsslacceptservercertextendedkeyusage(void* lpObj);

char* ipworksmq_xmpp_getsslacceptservercertfingerprint(void* lpObj);

char* ipworksmq_xmpp_getsslacceptservercertfingerprintsha1(void* lpObj);

char* ipworksmq_xmpp_getsslacceptservercertfingerprintsha256(void* lpObj);

char* ipworksmq_xmpp_getsslacceptservercertissuer(void* lpObj);

char* ipworksmq_xmpp_getsslacceptservercertprivatekey(void* lpObj);

int ipworksmq_xmpp_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* ipworksmq_xmpp_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* ipworksmq_xmpp_getsslacceptservercertpublickey(void* lpObj);

char* ipworksmq_xmpp_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int ipworksmq_xmpp_getsslacceptservercertpublickeylength(void* lpObj);

char* ipworksmq_xmpp_getsslacceptservercertserialnumber(void* lpObj);

char* ipworksmq_xmpp_getsslacceptservercertsignaturealgorithm(void* lpObj);

int ipworksmq_xmpp_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworksmq_xmpp_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* ipworksmq_xmpp_getsslacceptservercertstorepassword(void* lpObj);
int ipworksmq_xmpp_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int ipworksmq_xmpp_getsslacceptservercertstoretype(void* lpObj);
int ipworksmq_xmpp_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* ipworksmq_xmpp_getsslacceptservercertsubjectaltnames(void* lpObj);

char* ipworksmq_xmpp_getsslacceptservercertthumbprintmd5(void* lpObj);

char* ipworksmq_xmpp_getsslacceptservercertthumbprintsha1(void* lpObj);

char* ipworksmq_xmpp_getsslacceptservercertthumbprintsha256(void* lpObj);

char* ipworksmq_xmpp_getsslacceptservercertusage(void* lpObj);

int ipworksmq_xmpp_getsslacceptservercertusageflags(void* lpObj);

char* ipworksmq_xmpp_getsslacceptservercertversion(void* lpObj);

char* ipworksmq_xmpp_getsslacceptservercertsubject(void* lpObj);
int ipworksmq_xmpp_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int ipworksmq_xmpp_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksmq_xmpp_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Data Type

IPWorksMQCertificate

SSLCert Property (XMPP Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

IPWorksMQCertificate* GetSSLCert();
int SetSSLCert(IPWorksMQCertificate* val);

char* ipworksmq_xmpp_getsslcerteffectivedate(void* lpObj);

char* ipworksmq_xmpp_getsslcertexpirationdate(void* lpObj);

char* ipworksmq_xmpp_getsslcertextendedkeyusage(void* lpObj);

char* ipworksmq_xmpp_getsslcertfingerprint(void* lpObj);

char* ipworksmq_xmpp_getsslcertfingerprintsha1(void* lpObj);

char* ipworksmq_xmpp_getsslcertfingerprintsha256(void* lpObj);

char* ipworksmq_xmpp_getsslcertissuer(void* lpObj);

char* ipworksmq_xmpp_getsslcertprivatekey(void* lpObj);

int ipworksmq_xmpp_getsslcertprivatekeyavailable(void* lpObj);

char* ipworksmq_xmpp_getsslcertprivatekeycontainer(void* lpObj);

char* ipworksmq_xmpp_getsslcertpublickey(void* lpObj);

char* ipworksmq_xmpp_getsslcertpublickeyalgorithm(void* lpObj);

int ipworksmq_xmpp_getsslcertpublickeylength(void* lpObj);

char* ipworksmq_xmpp_getsslcertserialnumber(void* lpObj);

char* ipworksmq_xmpp_getsslcertsignaturealgorithm(void* lpObj);

int ipworksmq_xmpp_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksmq_xmpp_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworksmq_xmpp_getsslcertstorepassword(void* lpObj);
int ipworksmq_xmpp_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworksmq_xmpp_getsslcertstoretype(void* lpObj);
int ipworksmq_xmpp_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworksmq_xmpp_getsslcertsubjectaltnames(void* lpObj);

char* ipworksmq_xmpp_getsslcertthumbprintmd5(void* lpObj);

char* ipworksmq_xmpp_getsslcertthumbprintsha1(void* lpObj);

char* ipworksmq_xmpp_getsslcertthumbprintsha256(void* lpObj);

char* ipworksmq_xmpp_getsslcertusage(void* lpObj);

int ipworksmq_xmpp_getsslcertusageflags(void* lpObj);

char* ipworksmq_xmpp_getsslcertversion(void* lpObj);

char* ipworksmq_xmpp_getsslcertsubject(void* lpObj);
int ipworksmq_xmpp_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworksmq_xmpp_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksmq_xmpp_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

IPWorksMQCertificate

SSLEnabled Property (XMPP Class)

This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLEnabled();
int SetSSLEnabled(int bSSLEnabled);

Unicode (Windows)
BOOL GetSSLEnabled();
INT SetSSLEnabled(BOOL bSSLEnabled);

int ipworksmq_xmpp_getsslenabled(void* lpObj);
int ipworksmq_xmpp_setsslenabled(void* lpObj, int bSSLEnabled);

bool GetSSLEnabled();
int SetSSLEnabled(bool bSSLEnabled);

Default Value

FALSE

Remarks

This property specifies whether TLS/SSL is enabled in the class. When False (default), the class operates in plaintext mode. When True, TLS/SSL is enabled.

TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.

This property is not available at design time.

Data Type

Boolean

SSLProvider Property (XMPP Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int ipworksmq_xmpp_getsslprovider(void* lpObj);
int ipworksmq_xmpp_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCert Property (XMPP Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

IPWorksMQCertificate* GetSSLServerCert();

char* ipworksmq_xmpp_getsslservercerteffectivedate(void* lpObj);

char* ipworksmq_xmpp_getsslservercertexpirationdate(void* lpObj);

char* ipworksmq_xmpp_getsslservercertextendedkeyusage(void* lpObj);

char* ipworksmq_xmpp_getsslservercertfingerprint(void* lpObj);

char* ipworksmq_xmpp_getsslservercertfingerprintsha1(void* lpObj);

char* ipworksmq_xmpp_getsslservercertfingerprintsha256(void* lpObj);

char* ipworksmq_xmpp_getsslservercertissuer(void* lpObj);

char* ipworksmq_xmpp_getsslservercertprivatekey(void* lpObj);

int ipworksmq_xmpp_getsslservercertprivatekeyavailable(void* lpObj);

char* ipworksmq_xmpp_getsslservercertprivatekeycontainer(void* lpObj);

char* ipworksmq_xmpp_getsslservercertpublickey(void* lpObj);

char* ipworksmq_xmpp_getsslservercertpublickeyalgorithm(void* lpObj);

int ipworksmq_xmpp_getsslservercertpublickeylength(void* lpObj);

char* ipworksmq_xmpp_getsslservercertserialnumber(void* lpObj);

char* ipworksmq_xmpp_getsslservercertsignaturealgorithm(void* lpObj);

int ipworksmq_xmpp_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* ipworksmq_xmpp_getsslservercertstorepassword(void* lpObj);

int ipworksmq_xmpp_getsslservercertstoretype(void* lpObj);

char* ipworksmq_xmpp_getsslservercertsubjectaltnames(void* lpObj);

char* ipworksmq_xmpp_getsslservercertthumbprintmd5(void* lpObj);

char* ipworksmq_xmpp_getsslservercertthumbprintsha1(void* lpObj);

char* ipworksmq_xmpp_getsslservercertthumbprintsha256(void* lpObj);

char* ipworksmq_xmpp_getsslservercertusage(void* lpObj);

int ipworksmq_xmpp_getsslservercertusageflags(void* lpObj);

char* ipworksmq_xmpp_getsslservercertversion(void* lpObj);

char* ipworksmq_xmpp_getsslservercertsubject(void* lpObj);

int ipworksmq_xmpp_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

IPWorksMQCertificate

SSLStartMode Property (XMPP Class)

This property determines how the class starts the Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLStartMode();
int SetSSLStartMode(int iSSLStartMode);

Unicode (Windows)
INT GetSSLStartMode();
INT SetSSLStartMode(INT iSSLStartMode);

SSL_AUTOMATIC(0), 
SSL_IMPLICIT(1), 
SSL_EXPLICIT(2), 
SSL_NONE(3)

int ipworksmq_xmpp_getsslstartmode(void* lpObj);
int ipworksmq_xmpp_setsslstartmode(void* lpObj, int iSSLStartMode);

int GetSSLStartMode();
int SetSSLStartMode(int iSSLStartMode);

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Data Type

Integer

Status Property (XMPP Class)

This property holds the description of the availability of this entity.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetStatus();

Unicode (Windows)
LPWSTR GetStatus();

char* ipworksmq_xmpp_getstatus(void* lpObj);

QString GetStatus();

Default Value

"Available for Chat."

Remarks

When the class completes the initial login, it will send information telling other entities subscribed to this entity's presence that it is online.

The Presence property has one of four values representing general information about the user's status as defined in the Jabber protocol specification:

By default, the class sets the client presence to pcChat, meaning that the user is available.

Note: Offline is not officially supported by the XMPP specification; however, some XMPP server implementations may recognize the value. Setting the client's presence state to this value may cause the server to respond with an Error.

The Status property is a pure-text string representing the user's presence information. Its value maybe be any random string, including the empty string, "".

If the application or user wishes to associate a specific status message with a new presence value, it should use the ChangePresence method. ChangePresence will update both the Presence and Status properties, and then send that information to the server.

This property is read-only and not available at design time.

Data Type

String

Timeout Property (XMPP Class)

The timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int ipworksmq_xmpp_gettimeout(void* lpObj);
int ipworksmq_xmpp_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

User Property (XMPP Class)

This property includes the user portion of this entity's Jabber Id.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUser();
int SetUser(const char* lpszUser);

Unicode (Windows)
LPWSTR GetUser();
INT SetUser(LPCWSTR lpszUser);

char* ipworksmq_xmpp_getuser(void* lpObj);
int ipworksmq_xmpp_setuser(void* lpObj, const char* lpszUser);

QString GetUser();
int SetUser(QString qsUser);

Default Value

""

Remarks

The User property is a unique username associated with this entity and is set at the time of registration under the field "user".

Data Type

String

UserDomain Property (XMPP Class)

This property gets or sets the domain value used for Jabber Ids.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserDomain();
int SetUserDomain(const char* lpszUserDomain);

Unicode (Windows)
LPWSTR GetUserDomain();
INT SetUserDomain(LPCWSTR lpszUserDomain);

char* ipworksmq_xmpp_getuserdomain(void* lpObj);
int ipworksmq_xmpp_setuserdomain(void* lpObj, const char* lpszUserDomain);

QString GetUserDomain();
int SetUserDomain(QString qsUserDomain);

Default Value

""

Remarks

A Jabber Id (JID) is a unique identifier of the format "User@Domain/Resource". user@domain denotes the account by username and domain. The Resource is given during the login process to distinguish individual connections under the same account. If the IMServer contains multiple domains, this property setting allows the user to specify the domain under which to log in.

If Domain is empty, the value in IMServer is used by default when creating the client's JID.

Data Type

String

UserInfo Property (XMPP Class)

This property includes the collection of named registration fields.

Syntax

• C++
• C
• Qt

IPWorksMQList<IPWorksMQXMPPUserInfo>* GetUserInfo();
int SetUserInfo(IPWorksMQList<IPWorksMQXMPPUserInfo>* val);

int ipworksmq_xmpp_getuserinfocount(void* lpObj);
int ipworksmq_xmpp_setuserinfocount(void* lpObj, int iUserInfoCount);

char* ipworksmq_xmpp_getuserinfofield(void* lpObj, int fieldindex);
int ipworksmq_xmpp_setuserinfofield(void* lpObj, int fieldindex, const char* lpszUserInfoField);

char* ipworksmq_xmpp_getuserinfovalue(void* lpObj, int fieldindex);
int ipworksmq_xmpp_setuserinfovalue(void* lpObj, int fieldindex, const char* lpszUserInfoValue);

int GetUserInfoCount();
int SetUserInfoCount(int iUserInfoCount);

QString GetUserInfoField(int iFieldIndex);
int SetUserInfoField(int iFieldIndex, QString qsUserInfoField);

QString GetUserInfoValue(int iFieldIndex);
int SetUserInfoValue(int iFieldIndex, QString qsUserInfoValue);

Remarks

Before a registration can be attempted, the application should use the QueryRegister method to poll the host to which the user wishes to register. This will gather all of the necessary fields that the user must send to the server and will populate the UserInfo properties accordingly. After a successful query, all entries in UserInfo values will be empty strings.

The possible registration fields are defined in the Jabber protocol specification, as follows:

After the user has set all of the values in UserInfo, and added any extra fields they may wish to include in their registration, the application should make a call to Register.

If the class is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.

This collection is a hash-table type of collection in which the field string is used as the key to the desired XMPP user info object.

Example. Setting New User Information:

xmpp1.QueryRegister("server"); xmpp1.UserInfoCount = 2 xmpp1.UserInfoField(0) = "Username" xmpp1.UserInfoValue(0) = "newuser" xmpp1.UserInfoField(1) = "Password" xmpp1.UserInfoValue(1) = "newpass" xmpp1.Register("server");

This property is not available at design time.

Data Type

IPWorksMQXMPPUserInfo

Add Method (XMPP Class)

This method will add an entity to this entity's roster.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Add(const char* lpszJabberId, const char* lpszName, const char* lpszGroups);

Unicode (Windows)
INT Add(LPCWSTR lpszJabberId, LPCWSTR lpszName, LPCWSTR lpszGroups);

int ipworksmq_xmpp_add(void* lpObj, const char* lpszJabberId, const char* lpszName, const char* lpszGroups);

int Add(const QString& qsJabberId, const QString& qsName, const QString& qsGroups);

Remarks

JabberId is the Jabber Id of the entity to be added. It should be of form "user@host". If no hostname is specified, the class will assume the user's account is with the server in IMServer, and will append that hostname to JabberId before sending the request.

Name will contain the name that is to be associated with JabberId in this entity's roster. It may be the empty string, "".

Groups is either the empty string ("") or a comma- separated list of groups to which the JabberId is to be added. If JabberId already exists in the buddy list, it will be updated to exist only in the specified groups. A buddy's group list can also be modified by the Buddies property.

The Add method will make a subscription request to the presence of the specified JabberId. Upon receiving this request, the server will add an entry into this user's buddy list with a subscription of type subscriptionNone (0) if there was no previous entry (if this user has already allowed JabberId to subscribe to this user's presence, there will already be an entry of type subscriptionFrom (2)). If the contact chooses to allow the subscription, the server will update the entry and a BuddyUpdate event will fire with the new subscription value (subscriptionTo (1) if this is a new contact, or subscriptionBoth (3) if the contact is now mutual).

The XMPP protocol permits XMPP (Jabber) clients to communicate with foreign IM networks, such as AIM, MSN, SMS, and others, through the use of gateway servers that translate between the foreign protocol and XMPP. When sending or receiving presence information, messages, or subscription requests, Domain will be a gateway for the foreign network on which the contact resides and with which this user has registered an account for that foreign network. The Register method can be used to register with a foreign network gateway.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Cancel Method (XMPP Class)

This method will cancel another entity's subscription to this entity's presence.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Cancel(const char* lpszJabberId);

Unicode (Windows)
INT Cancel(LPCWSTR lpszJabberId);

int ipworksmq_xmpp_cancel(void* lpObj, const char* lpszJabberId);

int Cancel(const QString& qsJabberId);

Remarks

If for any reason the user should want to undo a previously granted subscription, this can be achieved through the Cancel method. The method will unsubscribe the target from this user's presence, thus preventing the target from seeing this user in the future.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ChangePassword Method (XMPP Class)

This method will change the current user's password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ChangePassword(const char* lpszPassword);

Unicode (Windows)
INT ChangePassword(LPCWSTR lpszPassword);

int ipworksmq_xmpp_changepassword(void* lpObj, const char* lpszPassword);

int ChangePassword(const QString& qsPassword);

Remarks

This method changes the current user's password to the password that is specified. The class must be connected to the server when this method is called.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ChangePresence Method (XMPP Class)

This method will set the availability and status of this entity.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ChangePresence(int iPresenceCode, const char* lpszStatus);

Unicode (Windows)
INT ChangePresence(INT iPresenceCode, LPCWSTR lpszStatus);

int ipworksmq_xmpp_changepresence(void* lpObj, int iPresenceCode, const char* lpszStatus);

int ChangePresence(int iPresenceCode, const QString& qsStatus);

Remarks

PresenceCode should correspond to the possible values of the Presence property:

By default, the class sets the client presence to pcChat, meaning that the user is available.

Note: Offline is not officially supported by the XMPP specification; however, some XMPP server implementations may recognize the value. Setting the client's presence state to this value may cause the server to respond with an Error.

Status can be any random string, including the empty string "".

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (XMPP Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksmq_xmpp_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Connect Method (XMPP Class)

This method will connect the class to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();

int ipworksmq_xmpp_connect(void* lpObj);

int Connect();

Remarks

The Connect method performs the entire connection routine. This includes connection to the IMServer, authenticating with the specified User and Password, and session initialization.

The Connected event will fire once for the initial Transmission Control Protocol (TCP) connection and again when the XMPP Logon is complete.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ConnectTo Method (XMPP Class)

This method will connect the class to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ConnectTo(const char* lpszUser, const char* lpszPassword);

Unicode (Windows)
INT ConnectTo(LPCWSTR lpszUser, LPCWSTR lpszPassword);

int ipworksmq_xmpp_connectto(void* lpObj, const char* lpszUser, const char* lpszPassword);

int ConnectTo(const QString& qsUser, const QString& qsPassword);

Remarks

The ConnectTo method performs the entire connection routine. This includes connection to the IMServer, user logon and authentication, and session initialization.

The Connected event will fire once for the initial Transmission Control Protocol (TCP) connection and again when the XMPP Logon is complete.

Because ConnectTo is called with a user and password specified, the User and Password properties will updated accordingly.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Disconnect Method (XMPP Class)

This method disconnects the class from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();

int ipworksmq_xmpp_disconnect(void* lpObj);

int Disconnect();

Remarks

The Disconnect method will send the disconnect command to the notification server. Upon disconnection, a Disconnected event will be fired.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DoEvents Method (XMPP Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworksmq_xmpp_doevents(void* lpObj);

int DoEvents();

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time and then returns.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Interrupt Method (XMPP Class)

This method interrupts the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworksmq_xmpp_interrupt(void* lpObj);

int Interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ProbePresence Method (XMPP Class)

Use this method to probe for another entity's presence.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ProbePresence(const char* lpszJabberId);

Unicode (Windows)
INT ProbePresence(LPCWSTR lpszJabberId);

int ipworksmq_xmpp_probepresence(void* lpObj, const char* lpszJabberId);

int ProbePresence(const QString& qsJabberId);

Remarks

In the case that the user needs to update a particular entity's presence, this method can be used to retrieve it. After a successful call, the server will either respond with the last known presence for Jabber or will send a presence element of type "error". In either case, the respond will be returned by a Presence event.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

QueryRegister Method (XMPP Class)

This method queries a server for the necessary registration fields.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int QueryRegister(const char* lpszXMPPServer);

Unicode (Windows)
INT QueryRegister(LPCWSTR lpszXMPPServer);

int ipworksmq_xmpp_queryregister(void* lpObj, const char* lpszXMPPServer);

int QueryRegister(const QString& qsXMPPServer);

Remarks

Before a registration can be attempted, the application should use the QueryRegister method to poll the host to which the user wishes to register. This will gather all of the necessary fields that the user must send to the server and will populate the UserInfo properties accordingly. After a successful query, all entries in UserInfo values will be empty strings.

The possible registration fields are defined in the Jabber protocol specification, as follows:

After the user has set all of the values in UserInfo, and added any extra fields they may wish to include in their registration, the application should make a call to Register.

If the class is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Register Method (XMPP Class)

This method registers an account with a server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Register(const char* lpszXMPPServer);

Unicode (Windows)
INT Register(LPCWSTR lpszXMPPServer);

int ipworksmq_xmpp_register(void* lpObj, const char* lpszXMPPServer);

int Register(const QString& qsXMPPServer);

Remarks

Before a registration can be attempted, the application should use the QueryRegister method to poll the host to which the user wishes to register. This will gather all of the necessary fields that the user must send to the server and will populate the UserInfo properties accordingly. After a successful query, all entries in UserInfo values will be empty strings.

The possible registration fields are defined in the Jabber protocol specification, as follows:

After the user has set all of the values in UserInfo, and added any extra fields they may wish to include in their registration, the application should make a call to Register.

If the class is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.

A new account can be registered at any time, including while the class is logged into the host under an existing account.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Remove Method (XMPP Class)

This method will remove an entity from this entity's roster.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Remove(const char* lpszJabberId, const char* lpszName, const char* lpszGroup);

Unicode (Windows)
INT Remove(LPCWSTR lpszJabberId, LPCWSTR lpszName, LPCWSTR lpszGroup);

int ipworksmq_xmpp_remove(void* lpObj, const char* lpszJabberId, const char* lpszName, const char* lpszGroup);

int Remove(const QString& qsJabberId, const QString& qsName, const QString& qsGroup);

Remarks

JabberId is the Jabber Id of the entity to be removed. It should be in the form of "user@host". If no hostname is specified, the class will assume the user's account is with the server in IMServer, and it will append that hostname to JabberId before sending the request.

Name should contain the name that is to be associated with JabberId in this entity's roster. It may be the empty string, "".

Groups may be either the empty string ("") or a comma- separated list of groups from which JabberId is to be removed. If no group is specified, the buddy will be completely removed from the buddy list.

After calling the Remove method, the server will remove the entry from the server-side roster and will push the result out to all connected resources. A BuddyUpdate event will fire with a subscription of type subscriptionRemove, and the entry will be removed from the Jabber class's internally stored list.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (XMPP Class)

This method will reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksmq_xmpp_reset(void* lpObj);

int Reset();

Remarks

This method will reset the class's properties to their default values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

RetrieveRoster Method (XMPP Class)

This method will retrieve this entity's roster from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RetrieveRoster();

Unicode (Windows)
INT RetrieveRoster();

int ipworksmq_xmpp_retrieveroster(void* lpObj);

int RetrieveRoster();

Remarks

After the class connects, it will automatically send a request to the server to retrieve the roster. If, however, the user or application wish to update the entire roster, this method may be used to do so.

After a successful call to the RetrieveRoster method, the server will respond with this entity's roster. The class will parse the roster and fire the Sync event once per item. This event may also fire for each entity added to or removed from the roster.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendCommand Method (XMPP Class)

This method sends a command to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendCommand(const char* lpszCommand);

Unicode (Windows)
INT SendCommand(LPCWSTR lpszCommand);

int ipworksmq_xmpp_sendcommand(void* lpObj, const char* lpszCommand);

int SendCommand(const QString& qsCommand);

Remarks

The SendCommand method will send the Command parameter to the server. The command must be in valid XML format and must be recognizable to the IMServer.

The SendCommand method should be used only by programmers or users who are connecting to nonstandard servers whose command list is not covered by the class. Any responses that are defined in the protocol specification will be returned by the appropriate event. Any nonstandard IQ message will be returned by the IQ event. All other responses will be returned by the PITrail event.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendFile Method (XMPP Class)

This method sends a file to the specified user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendFile(const char* lpszJabberId);

Unicode (Windows)
INT SendFile(LPCWSTR lpszJabberId);

int ipworksmq_xmpp_sendfile(void* lpObj, const char* lpszJabberId);

int SendFile(const QString& qsJabberId);

Remarks

This method sends the file specified by LocalFile to the user specified by the JabberId parameter.

JabberId is the intended recipient of the message. It is of the form user@domain/resource. If a resource is not supplied, all logged-in instances of the user's account will receive the message.

The class supports sending files using In-Band Bystestreams as defined in XEP-0047 and XEP-0096.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendMessage Method (XMPP Class)

This method will send a message to the specified user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* SendMessage(const char* lpszJabberId);

Unicode (Windows)
LPWSTR SendMessage(LPCWSTR lpszJabberId);

char* ipworksmq_xmpp_sendmessage(void* lpObj, const char* lpszJabberId);

QString SendMessage(const QString& qsJabberId);

Remarks

JabberId is the intended recipient of the message. It is of the form user@domain/resource. If a resource is not supplied, all logged-in instances of the user's account will receive the message.

The class associates several properties with messages it receives and sends. When it receives a message, the class will parse out the corresponding values and set these properties before firing a MessageIn event. After the event returns control to the class, the properties will be cleared (i.e., they will be set to the empty string, "").

Before sending a message, the application should set the appropriate properties to be associated with the message. The class will send only properties with nonempty string values ("") and will clear all properties after a successful send.

The associated properties are the following:

If the parameter passed to SendMessage is prefixed with "@" the component will interpret the value as a domain when constructing the message. This allows for sending directly to subdomains.

Note: The XMPP class will generate and return a unique identifier for each message sent. This identifier can be used to track messages in conjunction with various Jabber Extension Protocols.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

SetUserInfoField Method (XMPP Class)

This method will add a user information field for registration.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetUserInfoField(const char* lpszField, const char* lpszValue);

Unicode (Windows)
INT SetUserInfoField(LPCWSTR lpszField, LPCWSTR lpszValue);

int ipworksmq_xmpp_setuserinfofield(void* lpObj, const char* lpszField, const char* lpszValue);

int SetUserInfoField(const QString& qsField, const QString& qsValue);

Remarks

This method will search through UserInfo for the field name in Field and set the corresponding value to Value. If the field was not previously contained in UserInfo, it will automatically be added.

Before a registration can be attempted, the application should use the QueryRegister method to poll the host to which the user wishes to register. This will gather all of the necessary fields that the user must send to the server and will populate the UserInfo properties accordingly. After a successful query, all entries in UserInfo values will be empty strings.

The possible registration fields are defined in the Jabber protocol specification, as follows:

After the user has set all of the values in UserInfo, and added any extra fields they may wish to include in their registration, the application should make a call to Register.

If the class is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SubscribeTo Method (XMPP Class)

Use this method to subscribe to another entity's presence.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SubscribeTo(const char* lpszJabberId);

Unicode (Windows)
INT SubscribeTo(LPCWSTR lpszJabberId);

int ipworksmq_xmpp_subscribeto(void* lpObj, const char* lpszJabberId);

int SubscribeTo(const QString& qsJabberId);

Remarks

This method will send a request for a subscription to JabberId's presence. If the entity allows the subscription, a new item will be stored in the buddy list with the appropriate subscription type. Otherwise, no change will take place.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Unregister Method (XMPP Class)

This method cancels an account with the host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Unregister();

Unicode (Windows)
INT Unregister();

int ipworksmq_xmpp_unregister(void* lpObj);

int Unregister();

Remarks

If the user or application wishes to terminate an account with the IMServer it should make a call to this method. After a successful call, the account will be canceled and the class will be logged off the server, but not disconnected.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UnsubscribeTo Method (XMPP Class)

This method will cancel a subscription to another entity's presence.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UnsubscribeTo(const char* lpszJabberId);

Unicode (Windows)
INT UnsubscribeTo(LPCWSTR lpszJabberId);

int ipworksmq_xmpp_unsubscribeto(void* lpObj, const char* lpszJabberId);

int UnsubscribeTo(const QString& qsJabberId);

Remarks

This method will inform the server of the cancellation of a subscription to JabberId's presence. After a successful call, the subscription type of the associated buddy list item will be updated.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UpdateBuddyGroup Method (XMPP Class)

This method updates the buddy's associated groups.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateBuddyGroup(int iBuddyIndex, const char* lpszGroup);

Unicode (Windows)
INT UpdateBuddyGroup(INT iBuddyIndex, LPCWSTR lpszGroup);

int ipworksmq_xmpp_updatebuddygroup(void* lpObj, int iBuddyIndex, const char* lpszGroup);

int UpdateBuddyGroup(int iBuddyIndex, const QString& qsGroup);

Remarks

This method updates the associated groups for the buddy specified by BuddyIndex.

After the Sync event has fired, the Group field is populated with a comma-separated list of groups for each buddy. To update the groups for a buddy, call this method with the buddy's index and the comma-separated list of groups the buddy should be associated with. Setting Group to an empty string ("") will cause the buddy to be completely disassociated from all groups.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

BuddyUpdate Event (XMPP Class)

This event is fired whenever a roster entry is updated.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireBuddyUpdate(XMPPBuddyUpdateEventParams *e);

typedef struct {
  int BuddyIdx;
  int reserved;
} XMPPBuddyUpdateEventParams;


Unicode (Windows)
virtual INT FireBuddyUpdate(XMPPBuddyUpdateEventParams *e);

typedef struct {
  INT BuddyIdx;
  INT reserved;
} XMPPBuddyUpdateEventParams;

#define EID_XMPP_BUDDYUPDATE 1

virtual INT IPWORKSMQ_CALL FireBuddyUpdate(INT &iBuddyIdx);

class XMPPBuddyUpdateEventParams {
public:
  int BuddyIdx();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void BuddyUpdate(XMPPBuddyUpdateEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireBuddyUpdate(XMPPBuddyUpdateEventParams *e) {...}

Remarks

The BuddyUpdate event will fire whenever a new buddy list entry is added or an old entry is updated. The updated information can be retrieved through the Buddies properties property. The BuddyIdx parameter of this event will be the index of that XMPPBuddy in the properties.

Connected Event (XMPP Class)

This event is fired when a connection to the IM server is completed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnected(XMPPConnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} XMPPConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(XMPPConnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} XMPPConnectedEventParams;

#define EID_XMPP_CONNECTED 2

virtual INT IPWORKSMQ_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);

class XMPPConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connected(XMPPConnectedEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireConnected(XMPPConnectedEventParams *e) {...}

Remarks

If the connection is made normally, StatusCode is 0, and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (XMPP Class)

Fired to indicate changes in the connection state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionStatus(XMPPConnectionStatusEventParams *e);

typedef struct {
  const char *ConnectionEvent;
  int StatusCode;
  const char *Description;
  int reserved;
} XMPPConnectionStatusEventParams;


Unicode (Windows)
virtual INT FireConnectionStatus(XMPPConnectionStatusEventParams *e);

typedef struct {
  LPCWSTR ConnectionEvent;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} XMPPConnectionStatusEventParams;

#define EID_XMPP_CONNECTIONSTATUS 3

virtual INT IPWORKSMQ_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);

class XMPPConnectionStatusEventParams {
public:
  const QString &ConnectionEvent();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionStatus(XMPPConnectionStatusEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireConnectionStatus(XMPPConnectionStatusEventParams *e) {...}

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

Disconnected Event (XMPP Class)

This event is fired when the chat service connection is lost.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnected(XMPPDisconnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} XMPPDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(XMPPDisconnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} XMPPDisconnectedEventParams;

#define EID_XMPP_DISCONNECTED 4

virtual INT IPWORKSMQ_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);

class XMPPDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnected(XMPPDisconnectedEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireDisconnected(XMPPDisconnectedEventParams *e) {...}

Remarks

If the connection is broken normally, StatusCode is 0, and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

EndTransfer Event (XMPP Class)

This event is fired when a file transfer completes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndTransfer(XMPPEndTransferEventParams *e);

typedef struct {
  int Direction;
  const char *FileId;
  const char *FileName;
  int Success;
  int reserved;
} XMPPEndTransferEventParams;


Unicode (Windows)
virtual INT FireEndTransfer(XMPPEndTransferEventParams *e);

typedef struct {
  INT Direction;
  LPCWSTR FileId;
  LPCWSTR FileName;
  BOOL Success;
  INT reserved;
} XMPPEndTransferEventParams;

#define EID_XMPP_ENDTRANSFER 5

virtual INT IPWORKSMQ_CALL FireEndTransfer(INT &iDirection, LPSTR &lpszFileId, LPSTR &lpszFileName, BOOL &bSuccess);

class XMPPEndTransferEventParams {
public:
  int Direction();

  const QString &FileId();

  const QString &FileName();

  bool Success();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndTransfer(XMPPEndTransferEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireEndTransfer(XMPPEndTransferEventParams *e) {...}

Remarks

When a file transfer completes, this event will fire.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (XMPP Class)

This event is fired when the server sends a protocol error message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(XMPPErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} XMPPErrorEventParams;


Unicode (Windows)
virtual INT FireError(XMPPErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} XMPPErrorEventParams;

#define EID_XMPP_ERROR 6

virtual INT IPWORKSMQ_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class XMPPErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(XMPPErrorEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireError(XMPPErrorEventParams *e) {...}

Remarks

This event is fired whenever there is a protocol error. ErrorCode will contain the error code string sent by the server. Description will contain the Xmpp class's interpretation of the code.

IQ Event (XMPP Class)

This event is fired for IQ messages not normally supported by the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireIQ(XMPPIQEventParams *e);

typedef struct {
  const char *Iq;
  const char *Id;
  const char *From;
  const char *IqType;
  int Ignore;
  int reserved;
} XMPPIQEventParams;


Unicode (Windows)
virtual INT FireIQ(XMPPIQEventParams *e);

typedef struct {
  LPCWSTR Iq;
  LPCWSTR Id;
  LPCWSTR From;
  LPCWSTR IqType;
  BOOL Ignore;
  INT reserved;
} XMPPIQEventParams;

#define EID_XMPP_IQ 7

virtual INT IPWORKSMQ_CALL FireIQ(LPSTR &lpszIq, LPSTR &lpszId, LPSTR &lpszFrom, LPSTR &lpszIqType, BOOL &bIgnore);

class XMPPIQEventParams {
public:
  const QString &Iq();

  const QString &Id();

  const QString &From();

  const QString &IqType();

  bool Ignore();
  void SetIgnore(bool bIgnore);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void IQ(XMPPIQEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireIQ(XMPPIQEventParams *e) {...}

Remarks

Some servers may wish to gather some data from the client in ways not specified by the XMPP RFC. This event will contain any IQ message that is not a part of the Jabber specification. The Iq parameter will contain an entire XML entity, and thus it will require both knowledge of XML and knowledge of the possible contents of the IQ message to parse. Id will contain the transaction Id of the IQ message. From will contain the sender's Jabber Id. IqType will have one of the following values:

Note: To respond to these IQs, you may use the SendCommand method.

MessageIn Event (XMPP Class)

This event is fired upon receipt of a message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireMessageIn(XMPPMessageInEventParams *e);

typedef struct {
  const char *MessageId;
  const char *From;
  const char *Domain;
  const char *Resource;
  int MessageType;
  const char *Subject;
  const char *MessageThread;
  const char *MessageText;
  const char *MessageHTML;
  const char *Other;
  int reserved;
} XMPPMessageInEventParams;


Unicode (Windows)
virtual INT FireMessageIn(XMPPMessageInEventParams *e);

typedef struct {
  LPCWSTR MessageId;
  LPCWSTR From;
  LPCWSTR Domain;
  LPCWSTR Resource;
  INT MessageType;
  LPCWSTR Subject;
  LPCWSTR MessageThread;
  LPCWSTR MessageText;
  LPCWSTR MessageHTML;
  LPCWSTR Other;
  INT reserved;
} XMPPMessageInEventParams;

#define EID_XMPP_MESSAGEIN 8

virtual INT IPWORKSMQ_CALL FireMessageIn(LPSTR &lpszMessageId, LPSTR &lpszFrom, LPSTR &lpszDomain, LPSTR &lpszResource, INT &iMessageType, LPSTR &lpszSubject, LPSTR &lpszMessageThread, LPSTR &lpszMessageText, LPSTR &lpszMessageHTML, LPSTR &lpszOther);

class XMPPMessageInEventParams {
public:
  const QString &MessageId();

  const QString &From();

  const QString &Domain();

  const QString &Resource();

  int MessageType();

  const QString &Subject();

  const QString &MessageThread();

  const QString &MessageText();

  const QString &MessageHTML();

  const QString &Other();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void MessageIn(XMPPMessageInEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireMessageIn(XMPPMessageInEventParams *e) {...}

Remarks

When a message is received, the XMPP class will parse the sender's Jabber Id into the From, Domain, and Resource fields. These parameters can be used to track the exact instance of a user's account that originated the message.

MessageId can be used with Jabber extension protocols. The MessageText parameter is the plaintext portion of the message body. MessageHTML will contain any HTML from the message.

Type is the type of message received. See MessageType for a list of possible values. For a message of type "headline", Subject will reflect the subject of the message. For a message of type "chat", Thread will report the conversation thread for which the current message is a follow-up.

Other will contain any extra data associated with the message but not defined by the XMPP-IM protocol.

PITrail Event (XMPP Class)

This event is fired for all protocol messages.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePITrail(XMPPPITrailEventParams *e);

typedef struct {
  int Direction;
  const char *Pi;
  int reserved;
} XMPPPITrailEventParams;


Unicode (Windows)
virtual INT FirePITrail(XMPPPITrailEventParams *e);

typedef struct {
  INT Direction;
  LPCWSTR Pi;
  INT reserved;
} XMPPPITrailEventParams;

#define EID_XMPP_PITRAIL 9

virtual INT IPWORKSMQ_CALL FirePITrail(INT &iDirection, LPSTR &lpszPi);

class XMPPPITrailEventParams {
public:
  int Direction();

  const QString &Pi();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PITrail(XMPPPITrailEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FirePITrail(XMPPPITrailEventParams *e) {...}

Remarks

The PITrail event is useful for debugging purposes. It shows all the interactions between the client and the server, line by line.

SessionId will hold the session number that originated the PI. A value of 0 is reserved for all PI dealing with the IMServer.

The direction parameter shows the originator of the message:

The Pi parameter contains the PI message.

Presence Event (XMPP Class)

This event is fired when the presence of a subscribed entity changes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePresence(XMPPPresenceEventParams *e);

typedef struct {
  const char *User;
  const char *Domain;
  const char *Resource;
  int Availability;
  const char *Status;
  int reserved;
} XMPPPresenceEventParams;


Unicode (Windows)
virtual INT FirePresence(XMPPPresenceEventParams *e);

typedef struct {
  LPCWSTR User;
  LPCWSTR Domain;
  LPCWSTR Resource;
  INT Availability;
  LPCWSTR Status;
  INT reserved;
} XMPPPresenceEventParams;

#define EID_XMPP_PRESENCE 10

virtual INT IPWORKSMQ_CALL FirePresence(LPSTR &lpszUser, LPSTR &lpszDomain, LPSTR &lpszResource, INT &iAvailability, LPSTR &lpszStatus);

class XMPPPresenceEventParams {
public:
  const QString &User();

  const QString &Domain();

  const QString &Resource();

  int Availability();

  const QString &Status();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Presence(XMPPPresenceEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FirePresence(XMPPPresenceEventParams *e) {...}

Remarks

This event contains the availability and status information of a particular Jabber entity to whom this entity has a subscription.

Because a user can log in multiple times using the same account, the XMPP class will parse the user's Jabber Id into the User, Domain, and Resource parameters so that the client can easily track which instance of the account sent the presence.

The XMPP protocol permits XMPP (Jabber) clients to communicate with foreign IM networks, such as AIM, MSN, SMS, and others, through the use of gateway servers that translate between the foreign protocol and XMPP. When sending or receiving presence information, messages, or subscription requests, Domain will be a gateway for the foreign network on which the contact resides and with which this user has registered an account for that foreign network. The Register method can be used to register with a foreign network gateway.

Availability corresponds to the Presence property of the class, with the same possible values:

By default, the class sets the client presence to pcChat, meaning that the user is available.

Note: Offline is not officially supported by the XMPP specification; however, some XMPP server implementations may recognize the value. Setting the client's presence state to this value may cause the server to respond with an Error.

Status corresponds to the Status property. This value may be any random string, including the empty string, "".

ReadyToSend Event (XMPP Class)

This event is fired when the class is ready to send data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireReadyToSend(XMPPReadyToSendEventParams *e);

typedef struct {
  int reserved;
} XMPPReadyToSendEventParams;


Unicode (Windows)
virtual INT FireReadyToSend(XMPPReadyToSendEventParams *e);

typedef struct {
  INT reserved;
} XMPPReadyToSendEventParams;

#define EID_XMPP_READYTOSEND 11

virtual INT IPWORKSMQ_CALL FireReadyToSend();

class XMPPReadyToSendEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ReadyToSend(XMPPReadyToSendEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireReadyToSend(XMPPReadyToSendEventParams *e) {...}

Remarks

The ReadyToSend event indicates that the underlying Transmission Control Protocol (TCP)/IP subsystem is ready to accept data after a failed SendBytes. This event also is fired immediately after a connection to the remote host is established.

SSLServerAuthentication Event (XMPP Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(XMPPSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} XMPPSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(XMPPSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} XMPPSSLServerAuthenticationEventParams;

#define EID_XMPP_SSLSERVERAUTHENTICATION 12

virtual INT IPWORKSMQ_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class XMPPSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(XMPPSSLServerAuthenticationEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireSSLServerAuthentication(XMPPSSLServerAuthenticationEventParams *e) {...}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (XMPP Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(XMPPSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} XMPPSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(XMPPSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} XMPPSSLStatusEventParams;

#define EID_XMPP_SSLSTATUS 13

virtual INT IPWORKSMQ_CALL FireSSLStatus(LPSTR &lpszMessage);

class XMPPSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(XMPPSSLStatusEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireSSLStatus(XMPPSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (XMPP Class)

This event is fired when a file transfer begins.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStartTransfer(XMPPStartTransferEventParams *e);

typedef struct {
  int Direction;
  const char *FileId;
  const char *User;
  const char *Domain;
  const char *Resource;
  char *FileName;
  const char *Datetime;
  int64 Size;
  int Accept;
  int reserved;
} XMPPStartTransferEventParams;


Unicode (Windows)
virtual INT FireStartTransfer(XMPPStartTransferEventParams *e);

typedef struct {
  INT Direction;
  LPCWSTR FileId;
  LPCWSTR User;
  LPCWSTR Domain;
  LPCWSTR Resource;
  LPWSTR FileName;
  LPCWSTR Datetime;
  LONG64 Size;
  BOOL Accept;
  INT reserved;
} XMPPStartTransferEventParams;

#define EID_XMPP_STARTTRANSFER 14

virtual INT IPWORKSMQ_CALL FireStartTransfer(INT &iDirection, LPSTR &lpszFileId, LPSTR &lpszUser, LPSTR &lpszDomain, LPSTR &lpszResource, LPSTR &lpszFileName, LPSTR &lpszDatetime, LONG64 &lSize, BOOL &bAccept);

class XMPPStartTransferEventParams {
public:
  int Direction();

  const QString &FileId();

  const QString &User();

  const QString &Domain();

  const QString &Resource();

  const QString &FileName();
  void SetFileName(const QString &qsFileName);

  const QString &Datetime();

  qint64 Size();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void StartTransfer(XMPPStartTransferEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireStartTransfer(XMPPStartTransferEventParams *e) {...}

Remarks

When a file is received, the XMPP component will parse the sender's Jabber Id into the User, Domain, and Resource fields. The FileId and FileName parameters identify the current transfer. Within this event, you may override the FileName by setting the FileName parameter. At this time, you may also set LocalDirectory if it is not already set.

When sending a file, the XMPP component will parse the receiver's Jabber Id into the User, Domain, and Resource fields.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

SubscriptionRequest Event (XMPP Class)

This event fires when a subscription request is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSubscriptionRequest(XMPPSubscriptionRequestEventParams *e);

typedef struct {
  const char *From;
  const char *Domain;
  int Accept;
  int reserved;
} XMPPSubscriptionRequestEventParams;


Unicode (Windows)
virtual INT FireSubscriptionRequest(XMPPSubscriptionRequestEventParams *e);

typedef struct {
  LPCWSTR From;
  LPCWSTR Domain;
  BOOL Accept;
  INT reserved;
} XMPPSubscriptionRequestEventParams;

#define EID_XMPP_SUBSCRIPTIONREQUEST 15

virtual INT IPWORKSMQ_CALL FireSubscriptionRequest(LPSTR &lpszFrom, LPSTR &lpszDomain, BOOL &bAccept);

class XMPPSubscriptionRequestEventParams {
public:
  const QString &From();

  const QString &Domain();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SubscriptionRequest(XMPPSubscriptionRequestEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireSubscriptionRequest(XMPPSubscriptionRequestEventParams *e) {...}

Remarks

This event fires whenever another XMPP entity requests a subscription to this entity's presence. The XMPP class will parse the requesting entity's Jabber Id into the From and Domain parameters. It is not necessary to know which resource sent the request, because all instances of the requesting entity's account have access to the same roster.

Accept will initially be False, but setting it to True will cause the XMPP class to allow the remote subscription. Otherwise, the XMPP class will actively deny the subscription request.

Sync Event (XMPP Class)

This event fires upon a complete information synchronization with the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSync(XMPPSyncEventParams *e);

typedef struct {
  int reserved;
} XMPPSyncEventParams;


Unicode (Windows)
virtual INT FireSync(XMPPSyncEventParams *e);

typedef struct {
  INT reserved;
} XMPPSyncEventParams;

#define EID_XMPP_SYNC 16

virtual INT IPWORKSMQ_CALL FireSync();

class XMPPSyncEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Sync(XMPPSyncEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireSync(XMPPSyncEventParams *e) {...}

Remarks

The Sync event will fire after each successful call to the RetrieveRoster method. When the event fires, the buddy list, or roster, will be completely retrieved and the Buddies properties will be filled out accordingly:

Note: Please refer to Buddies properties property for more information.

Transfer Event (XMPP Class)

This event is fired during file transfer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTransfer(XMPPTransferEventParams *e);

typedef struct {
  int Direction;
  const char *FileId;
  const char *FileName;
  int64 BytesTransferred;
  int PercentDone;
  const char *Text;
  int lenText;
  int Cancel;
  int reserved;
} XMPPTransferEventParams;


Unicode (Windows)
virtual INT FireTransfer(XMPPTransferEventParams *e);

typedef struct {
  INT Direction;
  LPCWSTR FileId;
  LPCWSTR FileName;
  LONG64 BytesTransferred;
  INT PercentDone;
  LPCSTR Text;
  INT lenText;
  BOOL Cancel;
  INT reserved;
} XMPPTransferEventParams;

#define EID_XMPP_TRANSFER 17

virtual INT IPWORKSMQ_CALL FireTransfer(INT &iDirection, LPSTR &lpszFileId, LPSTR &lpszFileName, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText, BOOL &bCancel);

class XMPPTransferEventParams {
public:
  int Direction();

  const QString &FileId();

  const QString &FileName();

  qint64 BytesTransferred();

  int PercentDone();

  const QByteArray &Text();

  bool Cancel();
  void SetCancel(bool bCancel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Transfer(XMPPTransferEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireTransfer(XMPPTransferEventParams *e) {...}

Remarks

This event will fire when sending or receiving. One or more Transfer events are fired during file transfer.

The BytesTransferred parameter shows the number of bytes transferred since the beginning of the transfer.

Text contains the portion of the file data being delivered.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone cannot be calculated, the value will be -1.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksMQCertificate (declared in ipworksmq.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

Firewall Type

The firewall the component will connect through.

Syntax

IPWorksMQFirewall (declared in ipworksmq.h)

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

Firewall()

XMPPBuddy Type

This type describes a buddy in the XMPP buddy list.

Syntax

IPWorksMQXMPPBuddy (declared in ipworksmq.h)

Remarks

This type describes a buddy in the user's buddy list. Each buddy in the list has certain properties associated with it, such as names and Id.

Fields

Constructors

XMPPBuddy()

XMPPUserInfo Type

This type describes a named registration field.

Syntax

IPWorksMQXMPPUserInfo (declared in ipworksmq.h)

Remarks

This type describes the user information that must be sent to the server during registration.

Fields

Constructors

XMPPUserInfo()

XMPPUserInfo(const char* lpszField, const char* lpszValue)

IPWorksMQList Type

Syntax

IPWorksMQList<T> (declared in ipworksmq.h)

Remarks

IPWorksMQList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the XMPP class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

Config Settings (XMPP Class)

XMPP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Trappable Errors (XMPP Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

XMPP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors