Home > Class Reference > ENSLIB namespace > %BigData.Messaging


This class provides an abstract messaging API, internal to the sharding framework, that permits alternate underlying mechanisms to be substituted (e.g. TCP/IP devices or ECP/semaphores). In all methods, "client" and "server" may both be instances of shard server. In the descriptions, "client" and "server" refer to the role they are playing in the current messaging dialogue. Server side method to read a message from client.


Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 8


devs msg msgCode shards ssio
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
cliclose clirecv clisend reconnect
srvackclose srvclose srvrecv srvsend


property devs  [ MultiDimensional ];
Array of messaging devices subscripted by shard index
property msg as %String;
The most recently received message from the client (set by srvrecv()).
property msgCode as %String;
The message code from the most recently received message from the client.
property shards  [ MultiDimensional ];
Array of shard addresses corresponding to devs
property ssio ;
The server's I/O device


method cliclose(dev)
Close the specified device
method clirecv(dev) as %String
Client side method to read a reply from the server.
method clisend(dev, msg, qryId)
Client side method to send a message to server.
method reconnect(pMsgConnection) as %Status
Reconnect, after a dropped connection
method srvackclose()
Server acknowledge client's close request
method srvclose()
Close the server's device
method srvrecv() as %Library.Status
Server side method to receive a reply from a client. Sets msg to contain the message received (minus the message code), and msgCode to contain its message code.
method srvsend(reply)
Server side method to send a reply to a client.