Main Page   Class Hierarchy   Compound List   Compound Members  

ArTcpConnection Class Reference

For connectiong to a device through a socket. More...

#include <ArTcpConnection.h>

Inheritance diagram for ArTcpConnection::

ArDeviceConnection List of all members.

Public Types

enum  Open { OPEN_NET_FAIL = 1, OPEN_BAD_HOST, OPEN_NO_ROUTE, OPEN_CON_REFUSED }

Public Methods

 ArTcpConnection (void)
 Constructor.

virtual ~ArTcpConnection (void)
 Destructor also closes connection.

int open (const char *host=NULL, int port=8101)
 Opens a connection to the given host and port. More...

virtual bool openSimple (void)
 Opens the connection again, using the values from setLocation or.

virtual int getStatus (void)
 Gets the status of the connection, which is one of the enum status. More...

virtual bool close (void)
 Closes the connection. More...

virtual int read (const char *data, unsigned int size, unsigned int msWait=0)
 Reads data from connection. More...

virtual int write (const char *data, unsigned int size)
 Writes data to connection. More...

virtual std::string getOpenMessage (int messageNumber)
 Gets the string of the message associated with opening the device. More...

virtual ArTime getTimeRead (int index)
 Gets the time data was read in. More...

virtual bool isTimeStamping (void)
 sees if timestamping is really going on or not. More...

std::string getHost (void)
 Gets the name of the host connected to. More...

int getPort (void)
 Gets the number of the port connected to. More...

int internalOpen (void)
 Internal function used by open and openSimple.

void setSocket (ArSocket *socket)
 Sets the tcp connection to use this socket instead of its own. More...

ArSocketgetSocket (void)
 Gets the socket this tcp connection is using.

void setStatus (int status)
 Sets the status of the device, ONLY use this if you're playing with setSocket and know what you're doing.


Detailed Description

For connectiong to a device through a socket.


Member Enumeration Documentation

enum ArTcpConnection::Open
 

Enumeration values:
OPEN_NET_FAIL  Some critical part of the network isn't working.
OPEN_BAD_HOST  Could not find the host.
OPEN_NO_ROUTE  Know where the host is, but can't get to it.
OPEN_CON_REFUSED  Got to the host but it didn't allow a connection.


Member Function Documentation

bool ArTcpConnection::close void    [virtual]
 

Closes the connection.

Returns:
whether the close succeeded or not

Reimplemented from ArDeviceConnection.

std::string ArTcpConnection::getHost void   
 

Gets the name of the host connected to.

Returns:
the name of the host connected to
See also:
getPort

std::string ArTcpConnection::getOpenMessage int    messageNumber [virtual]
 

Gets the string of the message associated with opening the device.

Each class inherited from this one has an open method which returns 0 for success or an integer which can be passed into this function to obtain a string describing the reason for failure

Parameters:
messageNumber  the number returned from the open
Returns:
the error description associated with the messageNumber

Reimplemented from ArDeviceConnection.

int ArTcpConnection::getPort void   
 

Gets the number of the port connected to.

Returns:
the number of the port connected to
See also:
getHost

int ArTcpConnection::getStatus void    [virtual]
 

Gets the status of the connection, which is one of the enum status.

Gets the status of the connection, which is one of the enum status. If you want to get a string to go along with the number, use getStatusMessage

Returns:
the status of the connection
See also:
getStatusMessage

Reimplemented from ArDeviceConnection.

ArTime ArTcpConnection::getTimeRead int    index [virtual]
 

Gets the time data was read in.

Parameters:
index  looks like this is the index back in the number of bytes last read in
Returns:
the time the last read data was read in

Reimplemented from ArDeviceConnection.

bool ArTcpConnection::isTimeStamping void    [virtual]
 

sees if timestamping is really going on or not.

Returns:
true if real timestamping is happening, false otherwise

Reimplemented from ArDeviceConnection.

int ArTcpConnection::open const char *    host = NULL,
int    port = 8101
 

Opens a connection to the given host and port.

Parameters:
host  the host to connect to, if NULL (default) then localhost
port  the port to connect to
Returns:
0 for success, otherwise one of the open enums
See also:
getOpenMessage

int ArTcpConnection::read const char *    data,
unsigned int    size,
unsigned int    msWait = 0
[virtual]
 

Reads data from connection.

Reads data from connection

Parameters:
data  pointer to a character array to read the data into
size  maximum number of bytes to read
msWait  read blocks for this many milliseconds (not at all for < 0)
Returns:
number of bytes read, or -1 for failure
See also:
write, writePacket

Reimplemented from ArDeviceConnection.

void ArTcpConnection::setSocket ArSocket   socket
 

Sets the tcp connection to use this socket instead of its own.

This will make the connection use this socket, its useful for doing funkier things with sockets but still being able to use a device connection.

Parameters:
sock  the socket to use

int ArTcpConnection::write const char *    data,
unsigned int    size
[virtual]
 

Writes data to connection.

Writes data to connection

Parameters:
data  pointer to a character array to write the data from
size  number of bytes to write
Returns:
number of bytes read, or -1 for failure
See also:
read, writePacket

Reimplemented from ArDeviceConnection.


The documentation for this class was generated from the following files:
Generated on Tue Nov 12 17:44:07 2002 for Aria by doxygen1.2.13.1 written by Dimitri van Heesch, © 1997-2001