COVISE Core
Public Member Functions | Static Public Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
UDPComm Class Reference

#include <UDPComm.h>

Public Member Functions

 UDPComm (int localPort)
 
 UDPComm (int port, const char *hostname)
 
 UDPComm (const char *hostname, int port, int localPort, const char *mcastif=NULL, int mcastttl=-1)
 
 UDPComm (const char *hostPort, int localPort, const char *mcastif=NULL, int mcastttl=-1)
 
virtual ~UDPComm ()
 Destructor : virtual in case we derive objects. More...
 
int send (const void *buffer, int numsendBytes)
 
int send (const char *string)
 
int receive (void *buffer, int numBytes, double timeout=2.0)
 
int readMessage ()
 
int getMessagePart (void *buf, int size)
 
int enableBroadcast (bool state)
 
bool isBad ()
 
const char * errorMessage ()
 
const char * rawBuffer ()
 
int messageSize ()
 
int getReceiveSocket ()
 
sockaddr_in & getRemoteAddess ()
 

Static Public Member Functions

static void errorStatus_SW ()
 
static bool getError_SW ()
 
static void setError_SW (bool)
 

Protected Attributes

struct sockaddr_in d_address
 
char d_error [1024]
 
char msgBuf [UDP_COMM_MAX_SIZE]
 
char * currMsgPtr
 
int msgSize
 
int d_socket
 
int d_rsocket
 

Private Member Functions

unsigned long getIP (const char *hostname)
 
void setup (const char *hostname, int port, int localPort, const char *mcastif=NULL, int mcastttl=-1)
 
int openReceivePort (int portnumber)
 
 UDPComm (const UDPComm &)
 Copy-Constructor: NOT IMPLEMENTED, checked by assert. More...
 
UDPCommoperator= (const UDPComm &)
 Assignment operator: NOT IMPLEMENTED, checked by assert. More...
 
 UDPComm ()
 Default constructor: NOT IMPLEMENTED, checked by assert. More...
 

Private Attributes

sockaddr_in remote_adr
 
socklen_t rlen
 

Static Private Attributes

static bool error_SW = true
 

Detailed Description

Class for a very simple UDP communication

Constructor & Destructor Documentation

◆ UDPComm() [1/6]

UDPComm::UDPComm ( int  localPort)

Constructor Prepare receiver only / port

◆ UDPComm() [2/6]

UDPComm::UDPComm ( int  port,
const char *  hostname 
)

◆ UDPComm() [3/6]

UDPComm::UDPComm ( const char *  hostname,
int  port,
int  localPort,
const char *  mcastif = NULL,
int  mcastttl = -1 
)

Constructor send and receive Prepare sender to hostname / port

◆ UDPComm() [4/6]

UDPComm::UDPComm ( const char *  hostPort,
int  localPort,
const char *  mcastif = NULL,
int  mcastttl = -1 
)

Constructor send and receive Prepare sender to hostname/port given as "host:port"

◆ ~UDPComm()

UDPComm::~UDPComm ( )
virtual

Destructor : virtual in case we derive objects.

◆ UDPComm() [5/6]

UDPComm::UDPComm ( const UDPComm )
private

Copy-Constructor: NOT IMPLEMENTED, checked by assert.

Copy-Constructor: NOT IMPLEMENTED.

◆ UDPComm() [6/6]

UDPComm::UDPComm ( )
private

Default constructor: NOT IMPLEMENTED, checked by assert.

Default constructor: NOT IMPLEMENTED.

Member Function Documentation

◆ enableBroadcast()

int UDPComm::enableBroadcast ( bool  state)

◆ errorMessage()

const char * UDPComm::errorMessage ( )

◆ errorStatus_SW()

void UDPComm::errorStatus_SW ( )
static

◆ getError_SW()

bool UDPComm::getError_SW ( )
static

◆ getIP()

unsigned long UDPComm::getIP ( const char *  hostname)
private

◆ getMessagePart()

int UDPComm::getMessagePart ( void buf,
int  size 
)

◆ getReceiveSocket()

int UDPComm::getReceiveSocket ( )
inline

◆ getRemoteAddess()

sockaddr_in & UDPComm::getRemoteAddess ( )
inline

◆ isBad()

bool UDPComm::isBad ( )

◆ messageSize()

int UDPComm::messageSize ( )
inline

◆ openReceivePort()

int UDPComm::openReceivePort ( int  portnumber)
private

◆ operator=()

UDPComm & UDPComm::operator= ( const UDPComm )
private

Assignment operator: NOT IMPLEMENTED, checked by assert.

Assignment operator: NOT IMPLEMENTED.

◆ rawBuffer()

const char * UDPComm::rawBuffer ( )
inline

◆ readMessage()

int UDPComm::readMessage ( )

◆ receive()

int UDPComm::receive ( void buffer,
int  numBytes,
double  timeout = 2.0 
)

◆ send() [1/2]

int UDPComm::send ( const char *  string)

◆ send() [2/2]

int UDPComm::send ( const void buffer,
int  numsendBytes 
)

◆ setError_SW()

void UDPComm::setError_SW ( bool  status)
static

◆ setup()

void UDPComm::setup ( const char *  hostname,
int  port,
int  localPort,
const char *  mcastif = NULL,
int  mcastttl = -1 
)
private

Member Data Documentation

◆ currMsgPtr

char* UDPComm::currMsgPtr
protected

◆ d_address

struct sockaddr_in UDPComm::d_address
protected

◆ d_error

char UDPComm::d_error[1024]
protected

◆ d_rsocket

int UDPComm::d_rsocket
protected

◆ d_socket

int UDPComm::d_socket
protected

◆ error_SW

bool UDPComm::error_SW = true
staticprivate

◆ msgBuf

char UDPComm::msgBuf[UDP_COMM_MAX_SIZE]
protected

◆ msgSize

int UDPComm::msgSize
protected

◆ remote_adr

sockaddr_in UDPComm::remote_adr
private

◆ rlen

socklen_t UDPComm::rlen
private

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