libcore/plugins/tcpsst/MultiplexedSocket.hpp

Go to the documentation of this file.

/*  Sirikata Network Utilities
 *  MultiplexedSocket.hpp
 *
 *  Copyright (c) 2009, Daniel Reiter Horn
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are
 *  met:
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *  * Neither the name of Sirikata nor the names of its contributors may
 *    be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _SIRIKATA_TCPSST_MULTIPLEXED_SOCKET_HPP_
#define _SIRIKATA_TCPSST_MULTIPLEXED_SOCKET_HPP_

#include <sirikata/core/util/SerializationCheck.hpp>
#include <boost/thread.hpp>
#include "TCPSSTDecls.hpp"
#include "TCPStream.hpp"

namespace Sirikata {
namespace Network {

class ASIOReadBuffer;
class ASIOSocketWrapper;

class MultiplexedSocket:public SelfWeakPtr<MultiplexedSocket>, public SerializationCheck {
public:
    friend class ASIOReadBuffer;
    class RawRequest {
    public:
        bool unordered;
        bool unreliable;
        Stream::StreamID originStream;
        Chunk * data;

        uint32 size() const {
            return data->size();
        }
    };
    enum SocketConnectionPhase{
        PRECONNECTION,
        WAITCONNECTING,//need to fetch the lock, but about to connect
        CONNECTED,
        DISCONNECTED
    };
private:

//Begin Members//

    IOStrand* mIO;
    std::vector<ASIOSocketWrapper> mSockets;
    Stream::SubstreamCallback mNewSubstreamCallback;
    typedef std::tr1::unordered_map<Stream::StreamID,TCPStream::Callbacks*,Stream::StreamID::Hasher> CallbackMap;
    class StreamIDCallbackPair{
    public:
        Stream::StreamID mID;
        TCPStream::Callbacks* mCallback;
        StreamIDCallbackPair(Stream::StreamID id,TCPStream::Callbacks* cb):mID(id) {
            mCallback=cb;
        }
        std::pair<Stream::StreamID,TCPStream::Callbacks*> pair() const{
           return std::pair<Stream::StreamID,TCPStream::Callbacks*>(mID,mCallback);
        }
    };
    static boost::mutex sConnectingMutex;
    SizedThreadSafeQueue<RawRequest>* mNewRequests;
    volatile SocketConnectionPhase mSocketConnectionPhase;
    std::deque<StreamIDCallbackPair> mCallbackRegistration;
    CallbackMap mCallbacks;
    TCPStream::StreamType mStreamType;
    std::tr1::unordered_map<Stream::StreamID,unsigned int,Stream::StreamID::Hasher>mAckedClosingStreams;
    std::tr1::unordered_set<Stream::StreamID,Stream::StreamID::Hasher>mOneSidedClosingStreams;
#define ThreadSafeStack ThreadSafeQueue //FIXME this can be way more efficient

    AtomicValue<uint32> mHighestStreamID;
    ThreadSafeStack<Stream::StreamID>mFreeStreamIDs;
#undef ThreadSafeStack

//Begin helper functions//

    void ioReactorThreadCommitCallback(StreamIDCallbackPair& newcallback);
    bool CommitCallbacks(std::deque<StreamIDCallbackPair> &registration, SocketConnectionPhase status, bool setConnectedStatus=false);

    size_t leastBusyStream(size_t preferredStream);
    float dropChance(const Chunk*data,size_t whichStream);
    static bool sendBytesNow(const MultiplexedSocketPtr& thus,const RawRequest&data, bool force);
    void connectionFailureOrSuccessCallback(SocketConnectionPhase status, Stream::ConnectionStatus reportedProblem, const std::string&errorMessage=std::string());
    void connectionFailedCallback(const std::string& error);
    void hostDisconnectedCallback(const std::string& error);
public:
    TCPStream::StreamType getStreamType() const {
        return mStreamType;
    }
    IOStrand* getStrand() {return mIO;}

    static void closeStream(const MultiplexedSocketPtr& thus,const Stream::StreamID&sid,TCPStream::TCPStreamControlCodes code=TCPStream::TCPStreamCloseStream);

    static bool sendBytes(const MultiplexedSocketPtr& thus,const RawRequest&data, unsigned int maxSendQueueSize=2147483647);
    bool canSendBytes(Stream::StreamID origin,size_t dataSize)const;
    SocketConnectionPhase addCallbacks(const Stream::StreamID&sid, TCPStream::Callbacks* cb);
    Stream::StreamID getNewID();
    static Stream::StreamID getFirstStreamID(bool connector);
    MultiplexedSocket(IOStrand*io, const Stream::SubstreamCallback&substreamCallback, TCPStream::StreamType type);
    MultiplexedSocket(IOStrand*io, const UUID&uuid, const Stream::SubstreamCallback &substreamCallback, TCPStream::StreamType type);
    void initFromSockets(const std::vector<TCPSocket*>&sockets, size_t max_send_buffer_size);
    static void sendAllProtocolHeaders(const MultiplexedSocketPtr& thus, const std::string&origin, const std::string&host, const std::string&port, const std::string&resource_name, const std::string&subprotocol,bool doSendSubProtocol, const std::map<TCPSocket*,std::string>& response, TCPStream::StreamType streamType);
    ~MultiplexedSocket();
    void shutDownClosedStream(unsigned int controlCode,const Stream::StreamID &id);
    void receiveFullChunk(unsigned int whichSocket, Stream::StreamID id, Chunk&newChunk, const Stream::PauseReceiveCallback& pauseReceive);

    void receivePing(unsigned int whichSocket, MemoryReference data, bool isPong);

    void connectionFailedCallback(unsigned int whichSocket, const std::string& error);
    template <class ErrorCode> void connectionFailedCallback(const ErrorCode& error) {
        connectionFailedCallback(error.message());
    }
    template <class ErrorCode> void connectionFailedCallback(unsigned int whichSocket, const ErrorCode& error) {
        connectionFailedCallback(whichSocket,error.message());
    }
    template <class ErrorCode> void connectionFailedCallback(const ASIOSocketWrapper* whichSocket, const ErrorCode &error) {
        unsigned int which=0;
        for (std::vector<ASIOSocketWrapper>::iterator i=mSockets.begin(),ie=mSockets.end();i!=ie;++i,++which) {
            if (&*i==whichSocket)
                break;
        }
        connectionFailedCallback(which==mSockets.size()?0:which,error.message());
    }

    void hostDisconnectedCallback(unsigned int whichSocket, const std::string& error);
    template <class ErrorCode> void hostDisconnectedCallback(unsigned int whichSocket, const ErrorCode& error) {
        hostDisconnectedCallback(whichSocket,error.message());
    }
    template <class ErrorCode> void hostDisconnectedCallback(const ASIOSocketWrapper* whichSocket, const ErrorCode &error) {
        unsigned int which=0;
        for (std::vector<ASIOSocketWrapper>::iterator i=mSockets.begin(),ie=mSockets.end();i!=ie;++i,++which) {
            if (&*i==whichSocket)
                break;
        }
        hostDisconnectedCallback(which==mSockets.size()?0:which,error.message());
    }

    static void ioReactorThreadResumeRead(const MultiplexedSocketWPtr&, Stream::StreamID id);
    static void ioReactorThreadPauseSend(const MultiplexedSocketWPtr& mp, Stream::StreamID id);

    void connectedCallback() {
        connectionFailureOrSuccessCallback(CONNECTED,Stream::Connected);
    }
    void unpauseSendStreams(const std::vector<Stream::StreamID>&toUnpause);

    void connect(const Address&address, unsigned int numSockets, size_t maxEnqueuedSendSize, bool noDelay, unsigned int kernelSendBufferSize, unsigned int kernelReceiveBufferSize);

    void prepareConnect(unsigned int numSockets, size_t maxEnqueuedSendSize, bool noDelay, unsigned int kernelSendBufferSize, unsigned int kernelReceiveBufferSize);

    unsigned int numSockets() const {
        return mSockets.size();
    }
    ASIOSocketWrapper&getASIOSocketWrapper(unsigned int whichSocket){
        return mSockets[whichSocket];
    }
    const ASIOSocketWrapper&getASIOSocketWrapper(unsigned int whichSocket)const{
        return mSockets[whichSocket];
    }

    Address getRemoteEndpoint(Stream::StreamID id)const ;
    Address getLocalEndpoint(Stream::StreamID id)const ;

    // -- Statistics
    Duration averageSendLatency() const;
    Duration averageReceiveLatency() const;
};

} // namespace Network
} // namespace Sirikata


#endif //_SIRIKATA_TCPSST_MULTIPLEXED_SOCKET_HPP_