libcore/include/sirikata/core/network/Stream.hpp

Go to the documentation of this file.

/*  Sirikata Network Utilities
 *  Stream.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_Stream_HPP__
#define SIRIKATA_Stream_HPP__

#include <sirikata/core/network/Address.hpp>
#include <sirikata/core/util/Time.hpp>

namespace Sirikata {
namespace Network {

enum StreamReliability {
    Unreliable,
    ReliableUnordered,
    ReliableOrdered
};

class SIRIKATA_EXPORT Stream {
protected:
    Stream(){}
public:
    class SetCallbacks;

    virtual ~Stream(){};

    class StreamID: public vuint32 {
    public:
        StreamID(uint32 input) :vuint32(input){
        }
        StreamID(){}
        enum {
            MAX_HEX_SERIALIZED_LENGTH=sizeof(uint32)*2+1
        };
        static uint8 fromHex(char c) {
            if (c>='0'&&c<='9') return c-'0';
            if (c>='A'&&c<='Z') return (c-'A')+10;
            return (c-'a')+10;
        }
        static char toHex(uint8 h) {
            if (h<=9) return '0'+h;
            return (h-10)+'A';
        }
        unsigned int serializeToHex(uint8 *destination, unsigned int maxsize) const {
            assert(maxsize>1);
            uint32 tmp = read();
            unsigned int count=0;
            do {
                destination[count++]=toHex(tmp%16);
                tmp/=16;
            }while(count<maxsize&&tmp);
            std::reverse(destination,destination+count);
            destination[count++]='%';
            return count;
        }
        bool unserializeFromHex(const uint8*src, unsigned int&size) {
            if (size==0) return false;
            unsigned int maxsize=size;
            uint64 retval=0;
            uint64 temp=0;
            bool success=false;
            for (size=0;size<maxsize;++size) {
                char c=src[size];
                if (c=='%') {
                    ++size;
                    success=true;
                    break;
                }
                retval*=16;
                retval+=fromHex(c);
            }
            *this=StreamID((uint32)retval);
            return success;
        }

    };

    enum ConnectionStatus {
        Connected,
        ConnectionFailed,
        Disconnected
    };

    typedef std::tr1::function<void(void)> PauseReceiveCallback;

    typedef std::tr1::function<void(ConnectionStatus,const std::string&reason)> ConnectionCallback;

    typedef std::tr1::function<void(Stream*,SetCallbacks&)> SubstreamCallback;

    typedef std::tr1::function<void(Chunk&, const PauseReceiveCallback&)> ReceivedCallback;

    typedef std::tr1::function<void()> ReadySendCallback;

    class SetCallbacks : Noncopyable {
    public:
        virtual ~SetCallbacks(){}
        virtual void operator()(const Stream::ConnectionCallback &connectionCallback,
                                const Stream::ReceivedCallback &receivedCallback,
                                const Stream::ReadySendCallback&readySendCallback)=0;
    };

    static void ignoreSubstreamCallback(Stream * stream, SetCallbacks&);
    static void ignoreConnectionCallback(ConnectionStatus status,const std::string&reason);
    static void ignoreReceivedCallback(const Chunk&, const PauseReceiveCallback& );
    static void ignoreReadySendCallback();

    virtual void connect(
        const Address& addr,
        const SubstreamCallback& substreamCallback,
        const ConnectionCallback& connectionCallback,
        const ReceivedCallback& receivedCallback,
        const ReadySendCallback& readySendCallback)=0;

    virtual Stream* factory()=0;

    virtual Stream* clone(const SubstreamCallback&cb)=0;
    virtual Stream* clone(const ConnectionCallback &connectionCallback,
                          const ReceivedCallback&chunkReceivedCallback,
                          const ReadySendCallback&readySendCallback)=0;

    virtual void readyRead()=0;

    /* Request that the Stream call the ReadySendCallback specified by the user at stream creation when the
     * Stream is able to send additional data.  This can be called after a call to send() fails so the user
     * is notified when a message of the same size can be enqueued for sending. Calling this method
     * guarantees the user will receive the callback, even if space became available between the failure
     * of the send() call and the call to this method. Note that multiple requests may be handled by a
     * single callback and the callback may be invoked inside this method.
     */
    virtual void requestReadySendCallback()=0;

    virtual bool send(MemoryReference msg, StreamReliability reliability)=0;
    virtual bool send(MemoryReference first_msg, MemoryReference second_msg, StreamReliability reliability)=0;
    virtual bool send(const Chunk&data, StreamReliability reliability)=0;

    virtual bool canSend(size_t dataSize)const=0;

    virtual Address getRemoteEndpoint() const=0;
    virtual Address getLocalEndpoint() const=0;

    virtual void close()=0;


    // -- Statistics

    virtual Duration averageSendLatency() const {
        return Duration::zero();
    }

    virtual Duration averageReceiveLatency() const {
        return Duration::zero();
    }

};
} // namespace Network
} // namespace Sirikata

#endif //SIRIKATA_Stream_HPP__