BoapClientObject Class Reference

#include <BoapSimple.h>

Inheritance diagram for BoapClientObject:

Public Member Functions
	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)

Protected Member Functions
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
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.

Additional Inherited Members
Public Types inherited from BSocket
enum	NType { STREAM , DGRAM }
enum	Priority { PriorityLow , PriorityNormal , PriorityHigh }

Constructor & Destructor Documentation

BoapClientObject() [1/2]

BoapClientObject::BoapClientObject

(

BString

name = ""

)

~BoapClientObject()

BoapClientObject::~BoapClientObject ( )

virtual

BoapClientObject() [2/2]

BoapClientObject::BoapClientObject

(

BString

name

)

Member Function Documentation

checkApiVersion()

BError BoapClientObject::checkApiVersion ( )

protected

connectService() [1/2]

BError BoapClientObject::connectService

(

BString

name

)

Connects to the named service.

connectService() [2/2]

BError BoapClientObject::connectService

(

BString

name

)

disconnectService()

BError BoapClientObject::disconnectService

(

)

Disconnects from the named service.

getServiceName()

BString BoapClientObject::getServiceName

(

)

Get the name of the service.

handleReconnect()

BError BoapClientObject::handleReconnect ( BError  err )

protectedvirtual

Handle a reconnect performing autorisaztion if required.

performCall() [1/2]

BError BoapClientObject::performCall ( BoapPacket &  tx, BoapPacket &  rx  )

protected

Performs a RPC call to the named service.

performCall() [2/2]

BError BoapClientObject::performCall ( BoapPacket &  tx, BoapPacket &  rx  )

protected

performRecv() [1/2]

BError BoapClientObject::performRecv ( BoapPacket &  rx )

protected

Performs a receive.

performRecv() [2/2]

BError BoapClientObject::performRecv ( BoapPacket &  rx )

protected

performSend() [1/2]

BError BoapClientObject::performSend ( BoapPacket &  tx )

protected

Performs a send to the named service.

performSend() [2/2]

BError BoapClientObject::performSend ( BoapPacket &  tx )

protected

ping()

BError BoapClientObject::ping

(

BUInt32 &

apiVersion

)

Pings the connection and finds the remotes version number.

pingLocked()

BError BoapClientObject::pingLocked ( BUInt32 &  apiVersion )

protected

setConnectionPriority()

BError BoapClientObject::setConnectionPriority

(

BoapPriority

priority

)

Sets the connection priority.

setMaxLength()

void BoapClientObject::setMaxLength

(

BUInt32

maxLength

)

Sets the maximum packet length.

setTimeout()

void BoapClientObject::setTimeout

(

int

timeout

)

Sets the timeout in micro seconds. -1 is wait indefinitely.

Member Data Documentation

oapiVersion

BUInt32 BoapClientObject::oapiVersion

protected

oconnected

int BoapClientObject::oconnected

protected

olock

BMutex BoapClientObject::olock

protected

omaxLength

BUInt32 BoapClientObject::omaxLength

protected

oname

BString BoapClientObject::oname

protected

opriority

BoapPriority BoapClientObject::opriority

protected

oreconnect

int BoapClientObject::oreconnect

protected

Handle an automatic reconnect on timeout.

orx

BoapPacket BoapClientObject::orx

protected

oservice

BoapService BoapClientObject::oservice

protected

otimeout

int BoapClientObject::otimeout

protected

otx

BoapPacket BoapClientObject::otx

protected

---

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

• /src/cern/tms/tms/beam/libBeam/Boap.h
• /src/cern/tms/tms/beam/libBeam/BoapSimple.h
• /src/cern/tms/tms/beam/libBeam/Boap.cpp
• /src/cern/tms/tms/beam/libBeam/BoapSimple.cc