[Home]	[About]
[Screenshots]	[Download]
[News]	[Community]
[Documentation]	[Manual]
[Bugs & Requests]	[Wiki]

/home/tetron/hack/vos/libs/vos/vos/remotesocketsite.hh

Go to the documentation of this file.

#ifndef _REMOTESOCKETSITE_HH_
#define _REMOTESOCKETSITE_HH_

#include <stdexcept>

#include <vos/vos/siteextension.hh>
#include <vos/vos/message.hh>
#include <vos/vos/messageblock.hh>
#include <vos/vos/remotesite.hh>

namespace VOS {
    /** @class RemoteSocketSiteExtension remotesocketsite.hh vos/vos/remotesocketsite.hh
        @ingroup libvos

        Extends a remote site to support communication over a TCP/IP socket.
    */
    class VOS_API RemoteSocketSiteExtension : public RemoteSiteExtension
    {
    private:
        int socketFD;
        VUtil::vRef<MessageBlock> partialMessage;
        unsigned int sockSendBufSz;
        boost::mutex outputBuffer_mutex;
        std::string outputBuffer;
        Site* remotesite;
        std::string hostname;
        std::string remoteport;

    public:
        /** Initialize the site extension with an existing connection.
            @param socket the socket file descriptor
            @param peername the socket address info about the connected peer
        */
        RemoteSocketSiteExtension(int socket, sockaddr_in* peername);

        /** Make an outgoing connection to the supplied hostname, on
            the supplied port.
            @throw NoSuchSiteError if the connection could not be made
         */
        RemoteSocketSiteExtension(const std::string& hostname, unsigned short int port);

        /** Destructor */
        virtual ~RemoteSocketSiteExtension();

        /** Called when this extension is attached to the site */
        virtual void siteExtensionAttachedTo(Site* st);

        /** @return the remote site this extension is attached to */
        VUtil::vRef<Site> getRemoteSite() { return VUtil::vRef<Site>(remotesite, true); }

        /** @return the socket file descriptor */
        int getSocket() { return socketFD; }

        /** @return true if there is buffered data that is waiting to be sent */
        bool needWriteFlush() { return (outputBuffer.size() > 0); }

        /** @param data the buffer to store the data read from the socket
            @param datasize the maximum number of bytes to read
            @return the number of bytes actually read
        */
        int readStream(char* data, unsigned int datasize);

        /** @param data the buffer to be written to the socket
            @param datasize the number of bytes to be written
            @return the actual number of bytes that were written
        */
        int writeStream(const char* data, unsigned int datasize);

        /** Cleans up after the socket disconnects. */
        void handleDisconnection();

        /** Reads and parses any messages pending on the socket.
            @return a list of messages/message blocks
        */
        virtual std::list< VUtil::vRef<MessageBlock> > readQueuedMessages(bool block);

        /** Writes data to the socket until it has flushed the
            outgoing data buffer or gets EWOULDBLOCK (indicating that
            operating system socket buffers are full).

            @param newdata data to send; will be appended to any old data still in the
            output buffer
            @param newsize the size of the data to send
         */
        void pushOutgoingBuffer(const char* newdata = 0, unsigned int newsize = 0);

        /** Actually send a message to the socket
            @param state the vobjectstate for the site object.  not used.
            @param m the message
         */
        virtual void doSendMessage(VobjectState& state, Message* m);


        /** Actually send a message block to the socket
            @param state the vobjectstate for the site object.  not used.
            @param m the message block
         */
        virtual void doSendMessage(VobjectState& state, MessageBlock* m);

        virtual bool isConnected();
    };
};

#ifndef VOS_EXPORTS
IMPORT_METAOBJECT_FACTORIES(SocketProtocolHandler)
#endif

#endif