MulticastClient.h

Go to the documentation of this file.

#if !defined MulticastClient_h
#define MulticastClient_h

/*
* (c) Onix Solutions.
*/

#include <vector>

#include "./FIXEngineDefines.h"
#include "EngineException.h"

namespace FIXForge{
namespace Sockets{

/**
 * Provides User Datagram Protocol (UDP) multicast mode network services.
 */
class FF_API MulticastClient
{
public:
    /// Creates a MulticastClient.
    MulticastClient();

    /// Destructor.
    virtual ~MulticastClient();

    /// Adds a MulticastClient to the multicast group using all network interfaces.
    void join(const std::string& ip, int port);

    /// Adds a MulticastClient to the multicast group using the given network interface.
    void join(const std::string& ip, int port, const std::string& networkInterface);

    /// Leaves the multicast group.
    void drop();

    /**
     * Receives a multicast packet. 
     *
     * @note Blocks until the packet is received.
     * @note Multicast group must be joined first.
     *
     * @return The received multicast packet.
     */
    const std::vector<char>& receive();

    /**
     * Receives a multicast packet. 
     *
     * @note Blocks until the packet is received or the timeout period is elapsed.
     * @note Multicast group must be joined first.
     *
     * @return The received multicast packet or an empty vector if the timeout period is elapsed.
     */
    const std::vector<char>& receive(long timeoutInMilliseconds);

    /**
     * Sends the given multicast packet. 
     */
    void send(const std::string& packet);

    /**
     * Sends the given multicast packet. 
     */
    void send(const char* packet, size_t packetSize);
    
private:
    MulticastClient(const MulticastClient&);
    MulticastClient& operator = (const MulticastClient&);

    bool isJoined_;

    struct Impl;
    Impl* impl_;
};

}};

#endif

---