netcomlib.pkg File Reference

Data Structures
struct	NetComm
struct	NetUser

Typedefs
typedef struct mkNetComm	NetComm
typedef struct mkNetUser	NetUser

Functions
	isIP (s, i)
	getAppId (scenepath)
	netUserGetItemValue (netstr, userstr, item)
	Get a user item value.
	netUserSetItemValue (netstr, userstr, item, val)
	Set a user item value.
	netRoomGetItemValue (netstr, item)
	Get a room item value.
	netRoomSetItemValue (netstr, item, val)
	Set a room item value.
	netAddUser (netstr, id, login)
	netDelUser (netstr, userstr)
	netDelUserById (netstr, id)
	netUserSetLoginById (netstr, id, login)
	netUserSetLogin (netstr, userstr, login)
	netUserGetLoginById (netstr, id)
	netUserGetLogin (userstr)
	Get a user login.
	netUserGetId (userstr)
	Get a user id.
	netGetUserByLogin (netstr, login)
	Get a user by it's login.
	netGetUserById (netstr, id)
	Get a user by it's id.
	netThisId (netstr)
	Get the current client user id.
	netThisUser (netstr)
	Get the current client user.
	netThisLogin (netstr)
	Get the current client login.
	netGetNbUsers (netstr)
	Get the number of actual users.
	netSetCbConnected (netstr, cbfun)
	netSetCbClosed (netstr, cbfun)
	netSetCbSConnected (netstr, cbfun)
	netSetCbSrvMessage (netstr, cbfun)
	netSetCbUserMessage (netstr, cbfun)
	netSetCbUserPrivateMessage (netstr, cbfun)
	netSetCbGetFile (netstr, cbfun)
	netSetCbNewUser (netstr, cbfun)
	netSetCbDelUser (netstr, cbfun)
	netSetCbUserChangeLogin (netstr, cbfun)
	netSetCbUserGetItem (netstr, cbfun)
	netSetCbRoomGetItem (netstr, cbfun)
	netSetCbNbUsers (netstr, cbfun)
	netSetCbRoomChanged (netstr, cbfun)
	netSendMultiPart (netstr, userstr, flag, cmd, message, arg, pos)
	netSendFile (netstr, userstr, flag, cmd, filename)
	Send a file.
	netGetFile (netstr, userstr, flag, cmd, filename)
	Request a file.
	netSendMessageExt (netstr, cmd, message, arg)
	Send a message to the server with arguments.
	netSendMessage (netstr, cmd, message)
	Send a message to the server.
	netSendBroadMessageSecure (netstr, cmd, message, reply)
	Broad a secure message to all users connected in the same room.
	netSendBroadMessage (netstr, cmd, message, reply)
	Broad a message to all users connected in the same room.
	netUpdateUserItem (netstr, item, val)
	Set a client item value.
	netUpdateRoomItem (netstr, item, val)
	Set a room item value.
	netSendRsaMessage (netstr, cmd, message)
	Send a RSA encrypted message to the server.
	netSendPrivateMessageSecure (netstr, userstr, cmd, message)
	Send a secure private message to another user.
	netSendPrivateMessage (netstr, userstr, cmd, message)
	Send a private message to another user.
	netKickUser (netstr, userstr)
	Send a request to kick a user from the server. The user will be kicked only if several other users send this request.
	netCryptMessage (netstr, message, mode)
	netUnCryptMessage (netstr, message, mode)
	netFormatMessage (netstr, userstr, message)
	Format a message and replace itemname% by the user item values.
	netChannel (netstr)
	netIsConnected (netstr)
	Get the connection state.
	netDisconnect (netstr)
	Disconnect from the server.
	netCreateExt (server, port, script, env)
	Create a network structure to prepare the connection to a server with advanced parameters.
	netCreate (server, port)
	Create a network structure to prepare the connection to a server.
	netCreateMinimum ()
	Create an empty NetComm structure.
	netConnect (netstr)
	Connect to a server.
	netReconnect (netstr)
	Force a server re connection.
	netSetServer (netstr, server, port)
	Set a server url and port.
	netChangeLogin (netstr, login)
	Change the current user login.
	netChangeRoom (netstr, room)
	Change the current room.
	__connectedToServer (cid, clogin, srvpubkey)
	__srvMessage (mode, cmd, message, arg)
	__usrMessage (mode, from, cmd, message, arg)
	_connected ()
	_closed ()

Variables
defcom	cMessage = message I S S S S
var	iComFlagDefault =0
var	iComFlagRSA =1
var	iComFlagAES =2
var	iComFlagBroad =4
var	iComFlagMulti =8
var	iComFlagMultiEnd =16
var	iComFlagFile =32
var	iComFlagPrivate =64
var	iComFlagBroadOthers =128
var	iStatusDisconnected =0
var	iStatusConnected =1
var	iStatusSecurised =2
var	iMaxMessageSize =8192
proto	netIsConnected =fun [NetComm] I

Typedef Documentation

NetComm

typedef struct mkNetComm NetComm

NetUser

typedef struct mkNetUser NetUser

Function Documentation

isIP()

isIP	(	s	,
		i
	)

getAppId()

getAppId

(

scenepath

)

netAddUser()

netAddUser	(	netstr	,
		id	,
		login
	)

netDelUser()

netDelUser	(	netstr	,
		userstr
	)

netDelUserById()

netDelUserById	(	netstr	,
		id
	)

netUserSetLoginById()

netUserSetLoginById	(	netstr	,
		id	,
		login
	)

netUserSetLogin()

netUserSetLogin	(	netstr	,
		userstr	,
		login
	)

netUserGetLoginById()

netUserGetLoginById	(	netstr	,
		id
	)

netSetCbConnected()

netSetCbConnected	(	netstr	,
		cbfun
	)

netSetCbClosed()

netSetCbClosed	(	netstr	,
		cbfun
	)

netSetCbSConnected()

netSetCbSConnected	(	netstr	,
		cbfun
	)

netSetCbSrvMessage()

netSetCbSrvMessage	(	netstr	,
		cbfun
	)

netSetCbUserMessage()

netSetCbUserMessage	(	netstr	,
		cbfun
	)

netSetCbUserPrivateMessage()

netSetCbUserPrivateMessage	(	netstr	,
		cbfun
	)

netSetCbGetFile()

netSetCbGetFile	(	netstr	,
		cbfun
	)

netSetCbNewUser()

netSetCbNewUser	(	netstr	,
		cbfun
	)

netSetCbDelUser()

netSetCbDelUser	(	netstr	,
		cbfun
	)

netSetCbUserChangeLogin()

netSetCbUserChangeLogin	(	netstr	,
		cbfun
	)

netSetCbUserGetItem()

netSetCbUserGetItem	(	netstr	,
		cbfun
	)

netSetCbRoomGetItem()

netSetCbRoomGetItem	(	netstr	,
		cbfun
	)

netSetCbNbUsers()

netSetCbNbUsers	(	netstr	,
		cbfun
	)

netSetCbRoomChanged()

netSetCbRoomChanged	(	netstr	,
		cbfun
	)

netSendMultiPart()

netSendMultiPart	(	netstr	,
		userstr	,
		flag	,
		cmd	,
		message	,
		arg	,
		pos
	)

netCryptMessage()

netCryptMessage	(	netstr	,
		message	,
		mode
	)

netUnCryptMessage()

netUnCryptMessage	(	netstr	,
		message	,
		mode
	)

netChannel()

netChannel

(

netstr

)

__connectedToServer()

__connectedToServer	(	cid	,
		clogin	,
		srvpubkey
	)

__srvMessage()

__srvMessage	(	mode	,
		cmd	,
		message	,
		arg
	)

__usrMessage()

__usrMessage	(	mode	,
		from	,
		cmd	,
		message	,
		arg
	)

_connected()

_connected

(

)

_closed()

_closed

(

)

Variable Documentation

cMessage

defcom cMessage = message I S S S S

iComFlagDefault

var iComFlagDefault =0

iComFlagRSA

var iComFlagRSA =1

iComFlagAES

var iComFlagAES =2

iComFlagBroad

var iComFlagBroad =4

iComFlagMulti

var iComFlagMulti =8

iComFlagMultiEnd

var iComFlagMultiEnd =16

iComFlagFile

var iComFlagFile =32

iComFlagPrivate

var iComFlagPrivate =64

iComFlagBroadOthers

var iComFlagBroadOthers =128

iStatusDisconnected

var iStatusDisconnected =0

iStatusConnected

var iStatusConnected =1

iStatusSecurised

var iStatusSecurised =2

iMaxMessageSize

var iMaxMessageSize =8192

netIsConnected

proto netIsConnected =fun [NetComm] I