OnixS C++ FIX Engine  4.2.0
API Documentation
MulticastClient Class Reference

#include <OnixS/FIXEngine/Sockets/MulticastClient.h>

Public Types

enum  { MaximumUdpPacketSize = 65535 }
 

Public Member Functions

 MulticastClient ()
 
virtual ~MulticastClient ()
 
void join (const std::string &ip, int port)
 
void join (const std::string &ip, int port, const std::string &networkInterface)
 
void drop ()
 
const Bytes & receive ()
 
const Bytes & receive (long timeoutInMilliseconds)
 
void send (const std::string &packet)
 
void send (const void *packet, size_t packetSize)
 

Detailed Description

Definition at line 30 of file MulticastClient.h.

Member Enumeration Documentation

anonymous enum

Maximum UDP packet size.

Enumerator
MaximumUdpPacketSize 

Definition at line 73 of file MulticastClient.h.

Constructor & Destructor Documentation

virtual ~MulticastClient ( )
virtual

Finalize instance.

Member Function Documentation

void drop ( )

Leaves the multicast group.

void join ( const std::string &  ip,
int  port 
)

Adds a MulticastClient to the multicast group using all network interfaces.

void join ( const std::string &  ip,
int  port,
const std::string &  networkInterface 
)

Adds a MulticastClient to the multicast group using the given network interface.

const Bytes& receive ( )

Receives a multicast packet.

Note
Blocks until the packet is received.
Multicast group must be joined first.
Returns
The received multicast packet.
const Bytes& receive ( long  timeoutInMilliseconds)

Receives a multicast packet.

Note
Blocks until the packet is received or the timeout period is elapsed.
Multicast group must be joined first.
Returns
The received multicast packet or an empty vector if the timeout period is elapsed.
void send ( const std::string &  packet)

Sends the given multicast packet.

void send ( const void *  packet,
size_t  packetSize 
)

Sends the given multicast packet.


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