ngcbTCP2DRV Class Reference

#include <ngcbTCP2DRV.hpp>

Inheritance diagram for ngcbTCP2DRV:

Public Member Functions
	ngcbTCP2DRV ()
	Constructor.
virtual	~ngcbTCP2DRV ()
	Destructor.
int	ParseArguments (int argc, char **argv)
	Parse arguments.
void	PrintUsage (const char *argv0)
	Print usage.
char *	ErrMsg ()
	Return error message.
void	Logger (int flag, const char *msg)
	Logger (from ngcbSERVICE)
void	DeviceEvent (void *origin, void *event)
	Device event handler (from ngcbSERVICE)
int	Initialize ()
	Initialize server.
int	Abort ()
	Abort server.
int	MainLoop ()
	Enter server main-loop.
void	ExitSignal (int sig)
	Exit-signal handler.
int	TimerCB ()
	Timer call-back.
void	Verbose (const char *format,...) __attribute__((format(printf
	Verbose output.
void void	Log (const char *format,...) __attribute__((format(printf
	Log message.
void void void	Print (const char *format,...) __attribute__((format(printf
	Print verbose message.
void void void void	AddLog (const char *format,...) __attribute__((format(printf
	Add message to logging system.
Public Member Functions inherited from ngcbSIO
	ngcbSIO ()
	Constructor.
virtual	~ngcbSIO ()
	Destructor.
char *	ErrMsg ()
	Error message.
int	PortNum (int fd)
	Get port number.
int	GetIpAddr (const char *name, char *ipAddr)
	Get IP-address.
int	WaitSocket (int fd, int timeout)
	Wait with timeout until socket becomes readable.
int	TcpService (const char *service=NULL)
	Open a tcp/ip server socket.
int	TcpService (int port)
	Open a tcp/ip server socket.
int	TcpAccept (int srvSocket)
	Accept a tcp/ip connection request from a client.
int	TcpConnect (const char *service)
	Connect to a tcp/ip socket service.
int	TcpConnect (int port, const char *host=NULL)
	Connect to a tcp/ip socket service defined by port and host.
int	TcpClose (int fd)
	Close tcp/ip socket.
int	TcpRead (int fd, void *buffer, size_t size)
	Read buffer from tcp/ip socket.
int	TcpWrite (int fd, const void *buffer, size_t size)
	Write buffer to tcp/ip socket.
int	TcpPuts (int fd, const char *string)
	Put string to tcp/ip socket.
int	TcpGets (int fd, char *string, int maxLen)
	Get string from tcp/ip socket.
int	TcpReadRequest (int fd, char *request, int maxSize)
	Read request from tcp/ip socket.
int	TcpWriteReply (int fd, const char *reply, int success)
	Write reply to tcp/ip socket.
int	ExecVersion (const char *host)
	Return version of exec daemon or -1 if version cannot be retrieved.
int	Exec (const char *host, const char *cmd, char *reply, int port=0)
	Execute process on host.
int	ExecXt (const char *host, const char *cmd, char *reply, const char *geom=NULL)
	Execute process on host (in new terminal)
int	Kill (const char *host, int pid)
	Terminate process on host.
void	ExecReply (int fd, char success, const char *reply)
	Send reply to calling process.
int	Discover (const char *host, const char *name, const char *instance, int *port, int *protocol=NULL)
	Discover command/reply service on host.
int	Discover (const char *name, const char *instance, int *port, int *protocol=NULL)
	Discover command/reply service on local host.
int	Connect (const char *host, int port, int protocol, int *evtPort)
	Connect client to command/reply service.
int	Connect (const char *host, int port, int protocol)
	Connect to command/reply service with specific protocol.
int	Connect (const char *service, int protocol=ngcbSIO_PROTOCOL_ASCII)
	Connect to command/reply service with specific protocol.
void	Disconnect ()
	Disconnect from command/reply service.
int	Connected ()
	Return client connection status.
void	ReplyBufferSize (size_t size)
	Set reply buffer size of the client interface.
int	SendRequest (const char *request)
	Send request to server.
int	GetReply (char *s=NULL)
	Copy reply from server to string.
int	PrintReply (FILE *fd)
	Print server reply to stream.
int	ReplyLine (char *line)
	Read next reply line.
char *	Reply ()
	Reply buffer.
int	RequestReply (const char *request, char *reply=NULL)
	Run request/reply protocol.
int	OpenServer (int cmdPort, int evtPort=-1)
	Open socket server.
void	CloseServer ()
	Close socket server.
void	StopServer ()
	Terminate server main-loop.
int	SrvOpened ()
	Returns 1 when server is open.
virtual void	SetSrvAborted (int flag)
	Set server-aborted flag.
virtual int	SrvAborted ()
	Returns 1 when server-aborted flag is set.
int	SrvCmdPort ()
	Get actual server command port.
int	SrvEvtPort ()
	Get actual server event port.
int	SrvCmdSocket ()
	Get actual command server socket.
int	SrvEvtSocket ()
	Get actual event server socket.
int	OpenPort (int port, int protocol=0)
	Open service port.
int	ClosePort (int port)
	Close service port.
int	Port2Fd (int port)
	Return server socket associated to service port.
int	Fd2Port (int fd)
	Return service port associated to server socket.
int	ConnectCmd (int srvSocket, int protocol=0)
	Connect command client.
int	NumCmdClient ()
	Return number of command client connections.
int	HaveCmdClient ()
	Returns 1 in case any command client connection is established.
int	ConnectEvt (int srvSocket)
	Connect event client.
int	NumEvtClient ()
	Return number of event client connections.
int	HaveEvtClient ()
	Returns 1 in case any event client connection is established.
void	Broadcast (const void *buffer, size_t size)
	Broadcat buffer to all event clients.
void	Broadcast (const char *s)
	Broadcast string to all event clients.
int	Protocol (int fd)
	Run protocol when socket becomes readable.
int	ProtocolType ()
	Get preferred protocol type.
void	ProtocolType (int protocol)
	Set Protocol type.
int	GetProtocol (int fd)
	Get protocol type assigned to a given socket.
void	EnableStdIn ()
	Enable input via stdin.
void	DisableStdIn ()
	Disable input via stdin.
int	StdIn ()
	Get file-descriptor associated to the standard input.
int	FdAttach (int fd)
	Attach file-descriptor to the file descriptor event call-back.
void	FdDetach (int fd)
	Detach file-descriptor from the file descriptor event call-back.
void	TimerSet (int ms)
	Set timer (in milliseconds)
void	TimerOn ()
	Enable timer.
void	TimerOff ()
	Stop timmer.
int	MainLoop ()
	Enter socket server main-loop.
void	Lock ()
	Lock service main-loop.
void	Unlock ()
	Unlock service main-loop.
void	CleanupCmd (char *cmdLine, int *cmdLen)
	Clean command string (remove extra spaces etc.)
virtual void virtual void	Verbose (int level, const char *format,...) __attribute__((format(printf
	Verbose output function.
virtual void virtual void virtual void virtual void	Log (int level, const char *format,...) __attribute__((format(printf
	Logging function.
virtual void virtual void virtual void virtual void virtual void	LogMsg (const char *msg)
	Message logger.

Public Attributes
ngcbTCP2DRV_IFC	ifc
	Controller device.
Public Attributes inherited from ngcbSIO
int	verboseLevel
	Verbose level.
int	logLevel
	Loggin level.
int	ignoreSignal
	Ignore signal in main-loop select call.

Protected Member Functions
int	ProtocolBin (int fd)
	Binary command protocol.
Protected Member Functions inherited from ngcbSIO
virtual int	ProtocolAscii (int fd)
	ASCII protocol implementation.
virtual int	Service (int fd, int protocol)
	Application specific service protocol.
virtual int	ServiceConnect (int fd, int protocol)
	Application specific service connection protocol.
virtual void	ProtocolErr (const char *erms)
	Call-back to log protocol errors.
virtual int	RegisterService (int fd)
	Register command service.
virtual int	UnregisterService (int fd)
	Unregister command service.
virtual int	NewEventConnection (int fd)
	Call-back for new event client connection.
virtual int	FdCB (int fd)
	File descriptor event call-back.
virtual void	MainLoopInit ()
	Indicate main-loop initialization.

Detailed Description

NGC tcp/ip driver interface process class

Constructor & Destructor Documentation

ngcbTCP2DRV()

ngcbTCP2DRV::ngcbTCP2DRV

(

)

Constructor.

~ngcbTCP2DRV()

ngcbTCP2DRV::~ngcbTCP2DRV ( )

virtual

Destructor.

Member Function Documentation

Abort()

int ngcbTCP2DRV::Abort

(

)

Abort server.

AddLog()

void ngcbTCP2DRV::AddLog	(	const char *	format,
			... )

Add message to logging system.

DeviceEvent()

void ngcbTCP2DRV::DeviceEvent ( void * origin, void * event )

virtual

Device event handler (from ngcbSERVICE)

Reimplemented from ngcbSERVICE.

ErrMsg()

char * ngcbTCP2DRV::ErrMsg

(

)

Return error message.

ExitSignal()

void ngcbTCP2DRV::ExitSignal

(

int

sig

)

Exit-signal handler.

Initialize()

int ngcbTCP2DRV::Initialize

(

)

Initialize server.

Log()

void ngcbTCP2DRV::Log ( const char * format, ... )

virtual

Log message.

Reimplemented from ngcbSIO.

Logger()

void ngcbTCP2DRV::Logger ( int flag, const char * msg )

virtual

Logger (from ngcbSERVICE)

Reimplemented from ngcbSERVICE.

MainLoop()

int ngcbTCP2DRV::MainLoop

(

)

Enter server main-loop.

ParseArguments()

int ngcbTCP2DRV::ParseArguments	(	int	argc,
		char **	argv )

Parse arguments.

Print()

void ngcbTCP2DRV::Print	(	const char *	format,
			... )

Print verbose message.

PrintUsage()

void ngcbTCP2DRV::PrintUsage

(

const char *

argv0

)

Print usage.

ProtocolBin()

int ngcbTCP2DRV::ProtocolBin ( int fd )

protectedvirtual

Binary command protocol.

Reimplemented from ngcbSIO.

TimerCB()

int ngcbTCP2DRV::TimerCB ( )

virtual

Timer call-back.

Reimplemented from ngcbSIO.

Verbose()

void ngcbTCP2DRV::Verbose ( const char * format, ... )

virtual

Verbose output.

Reimplemented from ngcbSIO.

Member Data Documentation

ifc

ngcbTCP2DRV_IFC ngcbTCP2DRV::ifc

Controller device.

---

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

• core/ngcbDFE/src/include/ngc/core/ngcbTCP2DRV.hpp
• core/services/ngcbSock2Drv/src/main.cpp