This interface provides functions for events to be sent to clients from the TMS as a whole. More...

#include <TmsC.h>

Inheritance diagram for Tms::TmsEvent:

Public Member Functions
	TmsEvent (BString name="")

BError	errorEvent (BUInt32 cycleNumber, BError error)
	This event function gets called on a system error. The errorEvent object contains and error number and string describing the error. The getStatus() call can be used to fetch further information.

BError	cycleStartEvent (BUInt32 cycleNumber)
	This event function gets called on the CYCLE_START event with the cycle number about to be processed.

BError	cycleStopEvent (BUInt32 cycleNumber)
	This event function gets called on the CYCLE_END event with the cycle number completed.

BError	dataEvent (DataInfo dataInfo)
	This event function gets called when some requested data becomes available. The DataInfo object contains information on the data. The getData() call can be used to fetch the actual data.

Public Member Functions inherited from BoapClientObject
	BoapClientObject (BString name="")

virtual	~BoapClientObject ()

BError	connectService (BString name)
	Connects to the named service.

BError	disconnectService ()
	Disconnects from the named service.

BString	getServiceName ()
	Get the name of the service.

BError	ping (BUInt32 &apiVersion)
	Pings the connection and finds the remotes version number.

BError	setConnectionPriority (BoapPriority priority)
	Sets the connection priority.

void	setMaxLength (BUInt32 maxLength)
	Sets the maximum packet length.

void	setTimeout (int timeout)
	Sets the timeout in micro seconds. -1 is wait indefinitely.

	BoapClientObject (BString name)

BError	connectService (BString name)

Public Member Functions inherited from BSocket
	BSocket ()

	BSocket (int fd)

	BSocket (NType type)

	BSocket (int domain, int type, int protocol)

	~BSocket ()

BError	init (int domain, int type, int protocol)

BError	init (NType type)

void	setFd (int fd)

int	getFd ()

BError	bind (const BSocketAddress &add)

BError	connect (const BSocketAddress &add)

BError	shutdown (int how)

BError	close ()

BError	listen (int backlog=5)

BError	accept (int &fd)

BError	accept (int &fd, BSocketAddress &address)

BError	send (const void *buf, BSize nbytes, BSize &nbytesSent, int flags=0)

BError	sendTo (const BSocketAddress &address, const void *buf, BSize nbytes, BSize &nbytesSent, int flags=0)

BError	recv (void *buf, BSize maxbytes, BSize &nbytesRecv, int flags=0)

BError	recvFrom (BSocketAddress &address, void *buf, BSize maxbytes, BSize &nbytesRecv, int flags=0)

BError	recvWithTimeout (void *buf, BSize maxbytes, BSize &nbytesRecv, int timeout, int flags=0)

BError	recvFromWithTimeout (BSocketAddress &address, void *buf, BSize maxbytes, BSize &nbytesRecv, int timeout, int flags=0)

BError	setSockOpt (int level, int optname, void *optval, unsigned int optlen)

BError	getSockOpt (int level, int optname, void optval, unsigned int optlen)

BError	setReuseAddress (int on)

BError	setBroadCast (int on)

BError	setPriority (Priority priority)

BError	getMTU (uint32_t &mtu)

BError	getAddress (BSocketAddress &address)

Additional Inherited Members
Public Types inherited from BSocket
enum	NType { STREAM , DGRAM }

enum	Priority { PriorityLow , PriorityNormal , PriorityHigh }

Protected Member Functions inherited from BoapClientObject
BError	pingLocked (BUInt32 &apiVersion)

BError	checkApiVersion ()

BError	performCall (BoapPacket &tx, BoapPacket &rx)
	Performs a RPC call to the named service.

BError	performSend (BoapPacket &tx)
	Performs a send to the named service.

BError	performRecv (BoapPacket &rx)
	Performs a receive.

virtual BError	handleReconnect (BError err)
	Handle a reconnect performing autorisaztion if required.

BError	performSend (BoapPacket &tx)

BError	performRecv (BoapPacket &rx)

BError	performCall (BoapPacket &tx, BoapPacket &rx)

Protected Attributes inherited from BoapClientObject
BString	oname

BUInt32	oapiVersion

BoapPriority	opriority

BoapService	oservice

int	oconnected

BUInt32	omaxLength

BoapPacket	otx

BoapPacket	orx

BMutex	olock

int	otimeout

int	oreconnect
	Handle an automatic reconnect on timeout.

Detailed Description

This interface provides functions for events to be sent to clients from the TMS as a whole.

Constructor & Destructor Documentation

◆ TmsEvent()

Tms::TmsEvent::TmsEvent ( BString name = "" )

Member Function Documentation

◆ cycleStartEvent()

BError Tms::TmsEvent::cycleStartEvent ( BUInt32 cycleNumber )

This event function gets called on the CYCLE_START event with the cycle number about to be processed.

◆ cycleStopEvent()

BError Tms::TmsEvent::cycleStopEvent ( BUInt32 cycleNumber )

This event function gets called on the CYCLE_END event with the cycle number completed.

◆ dataEvent()

BError Tms::TmsEvent::dataEvent ( DataInfo dataInfo )

This event function gets called when some requested data becomes available. The DataInfo object contains information on the data. The getData() call can be used to fetch the actual data.

◆ errorEvent()

BError Tms::TmsEvent::errorEvent	(	BUInt32	cycleNumber,
		BError	error
	)

This event function gets called on a system error. The errorEvent object contains and error number and string describing the error. The getStatus() call can be used to fetch further information.

The documentation for this class was generated from the following files:

Account

Public Member Functions

Additional Inherited Members