DTrackSDK  v2.9.0
Public Member Functions | List of all members
DTrackNet::UDP Class Reference

Handling UDP data. More...

#include <DTrackNet.hpp>

Public Member Functions

 UDP (unsigned short port, unsigned int multicastIp=0)
 Initialize UDP socket. More...
 
 ~UDP ()
 Deinitialize UDP socket.
 
bool isValid ()
 Returns if UDP socket is open to receive data. More...
 
unsigned short getPort ()
 Get UDP data port where data is received. More...
 
unsigned int getRemoteIp ()
 Get IP address of sender of latest received data. More...
 
int receive (void *buffer, int maxLen, int toutUs)
 Receive UDP data. More...
 
int send (const void *buffer, int len, unsigned int ip, unsigned short port, int toutUs)
 Send UDP data. More...
 

Detailed Description

Handling UDP data.

Definition at line 64 of file DTrackNet.hpp.

Constructor & Destructor Documentation

◆ UDP()

DTrackNet::UDP::UDP ( unsigned short  port,
unsigned int  multicastIp = 0 
)

Initialize UDP socket.

Parameters
[in]portPort number, 0 if to be chosen by the OS
[in]multicastIpMulticast IP to listen (optional)

Definition at line 139 of file DTrackNet.cpp.

Member Function Documentation

◆ getPort()

unsigned short DTrackNet::UDP::getPort ( )

Get UDP data port where data is received.

Returns
Port number

Definition at line 260 of file DTrackNet.cpp.

Referenced by DTrackSDK::getDataPort().

◆ getRemoteIp()

unsigned int DTrackNet::UDP::getRemoteIp ( )

Get IP address of sender of latest received data.

Returns
IPv4 address

Definition at line 269 of file DTrackNet.cpp.

◆ isValid()

bool DTrackNet::UDP::isValid ( )

Returns if UDP socket is open to receive data.

Returns
Socket is valid

Definition at line 251 of file DTrackNet.cpp.

Referenced by DTrackSDK::isDataInterfaceValid().

◆ receive()

int DTrackNet::UDP::receive ( void *  buffer,
int  maxLen,
int  toutUs 
)

Receive UDP data.

Tries to receive one packet, as long as data is available.

Parameters
[out]bufferBuffer for UDP data
[in]maxLenLength of buffer
[in]toutUsTimeout in us (micro seconds)
Returns
Number of received bytes, <0 if error/timeout occured

Definition at line 278 of file DTrackNet.cpp.

Referenced by DTrackSDK::receive().

◆ send()

int DTrackNet::UDP::send ( const void *  buffer,
int  len,
unsigned int  ip,
unsigned short  port,
int  toutUs 
)

Send UDP data.

Parameters
[in]bufferBuffer for UDP data
[in]lenLength of buffer
[in]ipIPv4 address to send data to
[in]portPort number to send data to
[in]toutUsTimeout in us (micro sec)
Returns
0 if ok, <0 if error/timeout occured

Definition at line 347 of file DTrackNet.cpp.

Referenced by DTrackSDK::sendDTrack1Command().


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