jaus++/2.0/include/jaus/core/transport/jtcpclient.h

Go to the documentation of this file.

#ifndef __JAUS_CORE_TRANSPORT_TCP_CLIENT__H
#define __JAUS_CORE_TRANSPORT_TCP_CLIENT__H

#include "jaus/core/transport/transport.h"
#include "jaus/core/transport/jtcp.h"
#include <cxutils/networking/tcpclient.h>

namespace JAUS
{
    class TransportManager;
    class JAUS_CORE_DLL JTCPClient : public Transport,
                                     public JTCP
    {
    public:
        JTCPClient();
        virtual ~JTCPClient();
        // Load settings from a file.
        virtual bool LoadSettings(const std::string& filename);
        // Initializes the transport with a given ID for a component.
        virtual bool Initialize(const Address& componentID);
        // Initializes the transport with a given ID for a component.
        virtual bool Initialize(const Address& componentID, const IP4Address& host);
        // Returns true if transport has been initialized.
        virtual bool IsInitialized() const;
        // Shutsdown the transport service.
        virtual void Shutdown();
        // Sets maximum packet size.
        void SetMaxPacketSize(const unsigned int maxSizeBytes);
        // Gets the list of connections available (not supported).
        virtual Address::List GetConnections() const;
        // Gets a list of all manually created connections (not supported).
        virtual Address::List GetManualConnections() const { return JAUS::Address::List(); }
        // Returns true if connection is present.
        virtual bool HaveConnection(const Address& id) const;
        // Returns true if connection is present.
        virtual bool HaveConnection(const Address& id,
                                    const unsigned int timeSinceUpdateMs) const;
        // Send a serialized message.
        virtual bool SendPacket(const Packet& packet, 
                                const Header& header, 
                                const int broadcastFlags = NoBroadcast) const;
        // Serialize the JAUS message (add transport headers, serialize payload, etc.) 
        virtual bool SerializeMessage(const Message* message, 
                                      Packet::List& stream,
                                      Header::List& streamHeaders,
                                      const UShort startingSequenceNumber,
                                      const int broadcastFlag) const;
        // Get a copy of the transport header.
        virtual Packet GetTransportHeader() const { return mTransportHeader; }
        // Sets the host interface IP address to connect on.
        void SetInterfaceIP(const IP4Address& networkIP = IP4Address());
        // Turn on Debug Messages.
        virtual void EnableDebugMessages(const bool on = true);
        // Adds a connection to a specific IP address.
        bool AddConnection(const IP4Address& networkIP,
                           const Address& jausID);
    private:
        virtual void ProcessPacket(Packet& packet,
                                   Header& header,
                                   const IP4Address& ipAddress,
                                   const unsigned short sourcePort);
        virtual void CheckServiceStatus(const unsigned int timeSinceLastCheckMs);
        unsigned int mMaxPayloadSize;                    
        CxUtils::IP4Address mHostIP;                     
        std::map<Address, Time::Stamp> mUpdateTimes;     
        Packet mTransportHeader;                         
        TransportManager* mpTransportManager;            
        Time::Stamp mDisconnectTimeMs;                   
    };
}

#endif
/*  End of File */