Difference between revisions of "Broker msg specs"

Revision as of 00:40, 14 February 2012

Name	Type	Description
ClearParameters	Boolean	Clears parameters after every RPC call
ClearResults	Boolean	Clears results after every RPC call
Connected	Boolean	Sets and Displays the connection status
DebugMode	Boolean	Allows client server debugging
ListenerPort	Integer	<st1:place w:st="on"><st1:PlaceName w:st="on">Server</st1:PlaceName> <st1:PlaceName w:st="on">TCP/IP</st1:PlaceName> <st1:PlaceType w:st="on">Port</st1:PlaceType></st1:place>
Results	Tstrings	Results of the call in list form
RemoteProcedure	String[100]	* .01 of Remote Procedure file
RpcVersion	String[255]	* Application version
Server	String[255]	* TCP Server name, resolved with Winsock standard library

Name	Type	Description
Param	Tparams	array of TParamRecord
Socket	Integer	Read Only. Active socket, otherwise 0. Passed as parameter to some low level calls.
RPCTimeLimit	Integer	Timeout for Network I/O
Call	Procedure	Executes RPC, return in Results
lstCall	Procedure	Like Call, requires TStrings Parameter to place results
pchCall	PChar	Function, returns PChar
strCall	String	Function, returns single string
CreateContext	Boolean	Function, requires Context name (string) as parameter. Used by Kernel Security

Name	Type	Description
ParamArray[I: integer]	TParamRecord	Used to specify multiple M parameters

Name	Type	Description
Value	String	M Parameter value
PType	Enum	literal, reference, list, undefined
Mult	TMult	Used to specify M array.

Name	Type	Description
MultArray[I: string]	String	Used to specify M array. Setting is done using procedure SetFMultiple(Index: string; value: string); Subscript is stored as the String, value is stored as an object of the string

Name	Type	Code	Value	Comment
Prefix	Fixed	HDR	{XWB}	Required
Reserved	String		5 chars	L_PACK of entire message for v1.0, disregard for v1.1
Version Flag	String		1 char	\| (ASCII 124) for v1.1
App Version	String		S_PACK	Default is 0 for v1.1 so 2 chars minimum
Length	String		5 chars	L_PACK of RPC Info and RPC parameters
Length	String		3 chars	Length of RPC Info
Workstation ID	String	WKID	variable	null: default, ; (ASCII 59) as separator
Window handle	String	WINH	variable	null: default, ; (ASCII 59) as separator
Process handle	String	PRCH	variable	null: default, ; (ASCII 59) as separator
Window Server	String	WISH	variable	null: default, ; (ASCII 59) as separator
Length	String		5 chars	L_PACK of RPC name and all parameters
Array Flag	Int		0, 1	1 indicates that last parameter is an array
RPC Name	String		variable	Separated by ^ (ASCII 94)

Name	Type	Code	Value	Comment
Array Flag			0, 1	1 indicates last parameter is an array
RPC Name	String		variable	Separated by ^ (ASCII 94)
Length	String		5 chars	L_PACK of all remaining parameters
Length	String		3 chars	L_PACK of parameter
Type	Int		0, 1, 2	0: literal, 1: reference, 2: array
Parameter	String		variable	Parameter