jabber client manager or factory
More...
#include <ParaScriptingJabberClient.h>
jabber client manager or factory
§ AddStringMap()
| static void ParaScripting::JabberClientManager::AddStringMap |
( |
int |
nID, |
|
|
const char * |
sString |
|
) |
| |
|
static |
add string a string mapping.
We will automatically encode NPL filename string if it is in this string map. It means shorter message sent over the network. use AddStringMap whenever you want to add a string to the map. Please note, that the sender and the receiver must maintain the same string map in memory in order to have consistent string translation result. the function is static, it will apply to all client instances.
- Parameters
-
| nID | the integer to encode the string. it is usually positive. |
| sString | the string for the id. if input is NULL, it means removing the mapping of nID. |
§ CloseJabberClient()
| static bool ParaScripting::JabberClientManager::CloseJabberClient |
( |
const char * |
sJID | ) |
|
|
static |
close a given jabber client instance.
Basically, there is no need to close a web service, unless one wants to reopen it with different credentials
- Parameters
-
| sJID | such as "lixizhi@paraweb3d.com", if this is "", it will close all jabber clients. |
§ CreateJabberClient()
| static NPLJabberClient ParaScripting::JabberClientManager::CreateJabberClient |
( |
const char * |
sJID | ) |
|
|
static |
Create a new jabber client instance with the given jabber client ID.
It does not open a connection immediately.
- Parameters
-
| sJID | such as "lixizhi@paraweb3d.com" |
§ GetJabberClient()
| static NPLJabberClient ParaScripting::JabberClientManager::GetJabberClient |
( |
const char * |
sJID | ) |
|
|
static |
get an existing jabber client instance interface by its JID.
If the client is not created using CreateJabberClient() before, function may return NULL.
- Parameters
-
| sJID | such as "lixizhi@paraweb3d.com" |
The documentation for this class was generated from the following file:
