newspeoplefor developersdocumentationdownloads

nSessionClient Script Interface

nsessionclient:

Super Class:

C++ Class:

Info

The network session client class.

Commands:


setappname

Command Input:
s(AppName)
Command Output:
v
Command Description:
Set the application name. Will be used together with the AppVersion to identify sessions.

getappname

Command Input:
v
Command Output:
s(AppName)
Command Description:
Get the application name.

setappversion

Command Input:
s(AppVersion)
Command Output:
v
Command Description:
Set the version string. Will be used together with the AppName to identify sessions.

getappversion

Command Input:
v
Command Output:
s(AppVersion)
Command Description:
Get the application version string.

setclientattr

Command Input:
s(AttrName), s(AttrValue)
Command Output:
v
Command Description:
Set a client attribute.

getclientattr

Command Input:
s(AttrName)
Command Output:
s(AttrValue)
Command Description:
Get a client attribute.

getnumclientattrs

Command Input:
v
Command Output:
i(NumClientAttrs)
Command Description:
Get number of client attributes.

getclientattrat

Command Input:
i(AttrIndex)
Command Output:
s(AttrName), s(AttrValue)
Command Description:
Get a client attribute by index.

getnumservers

Command Input:
v
Command Output:
i(NumDiscoveredServers)
Command Description:
Get number of discovered servers.

getserverat

Command Input:
i(Index)
Command Output:
o(ServerContextObject)
Command Description:
Get session server object at given index.

getjoinedserver

Command Input:
v
Command Output:
o(ServerContextObject)
Command Description:
Get reference to joined server.

open

Command Input:
v
Command Output:
b(Success)
Command Description:
Open the session client. This will start discovering open sessions on the network.

close

Command Input:
v
Command Output:
v
Command Description:
Close the session client.

isopen

Command Input:
v
Command Output:
b(OpenFlag)
Command Description:
Check if session client is currently open.

joinsession

Command Input:
s(SessionGuid)
Command Output:
b(PartialSuccessCode)
Command Description:
Send a join request to the session server identified by the session's guid. The success code only indicates, whether a session of that guid could be found, it does NOT indicate whether the join was successful. The session server will reply a join accepted or denied message at some later time.

leavesession

Command Input:
v
Command Output:
b
Command Description:
Leave the currently joined session.

isjoined

Command Input:
v
Command Output:
b(JoinedFlag)
Command Description:
Return true if currently joined to a session.

isjoinaccepted

Command Input:
v
Command Output:
b(JoinAcceptedFlag)
Command Description:
Return true if the server had accepted the join session request.

isjoindenied

Command Input:
v
Command Output:
b(JoinDeniedFlag)
Command Description:
Return true if the server had denied the join session request.

Copyright © 1999-2005 by the contributing authors. Ideas, requests, problems: Send feedback.