Session.h

/*
-----------------------------------------------------------------------------
This source file is part of "esnetwork" library.
It is licensed under the terms of the BSD license.
For the latest info, see http://esnetwork.sourceforge.net

Copyright (c) 2012-2013 Lin Jia Jun (Joe Lam)
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. 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.

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 _ESN_SESSION_H_
#define _ESN_SESSION_H_

#include <vector>

#include <boost/shared_ptr.hpp>
#include <boost/weak_ptr.hpp>

#include "CommonData.h"

namespace esnlib
{

class Buffer;
class IoBuffer;
class IoFilter;
class IoHandler;

class Session
{

public:

    Session();
    virtual ~Session();

    virtual void Open() = 0;

    virtual void Close(bool rightnow = true) = 0;

    virtual bool Connected() = 0;

    virtual void Write(boost::shared_ptr<IoBuffer> data) = 0;

    virtual void Write(const char* buf, int bufsize) = 0;

    virtual void Write(void* data) = 0;

    virtual void WriteData(void* data) = 0;

    virtual void WriteBuffer(boost::shared_ptr<IoBuffer> data) = 0;

    virtual void Broadcast(boost::shared_ptr<IoBuffer> data) = 0;

    virtual void Broadcast(void* data) = 0;

    virtual int GetSessionCount() = 0;

    virtual int GetSessions(std::vector< boost::shared_ptr<Session> > & sessions) = 0;

    virtual boost::shared_ptr<Session> GetSessionById(int id) = 0;

    virtual bool TestIdle(int idletype, int idletime) = 0;

    virtual int GetId() = 0;

    virtual void SetId(int id) = 0;

    virtual bool GetOrderlyHandling(int optype) = 0;

    virtual void SetOrderlyHandling(int optype, bool value) = 0;

    virtual int GetMaxMessageQueueSize(int optype) = 0;

    virtual void SetMaxMessageQueueSize(int optype, int value) = 0;

    virtual int GetState() = 0;

    virtual boost::shared_ptr<IoFilter> GetIoFilter() = 0;

    virtual boost::shared_ptr<IoHandler> GetIoHandler() = 0;

    virtual boost::shared_ptr<IoBuffer> GetReadCache() = 0;

    virtual boost::shared_ptr<IoBuffer> GetFreeBuffer(int bufsize) = 0;

    virtual void TakeBack(boost::shared_ptr<IoBuffer> buf) = 0;

    virtual void TakeBack(boost::shared_ptr<Buffer> buf) = 0;

    virtual boost::shared_ptr<IoBuffer> EncodeBuffer(void* data) = 0;

    virtual void* DecodeBuffer(boost::shared_ptr<IoBuffer> data) = 0;

    virtual bool HasSsl() = 0;

    virtual bool HasData() = 0;

    virtual CommonDataPtr GetData() = 0;

    virtual bool HasGlobalData() = 0;

    virtual CommonDataPtr GetGlobalData() = 0;

    virtual std::string GetRemoteIp() = 0;

    virtual int GetRemotePort() = 0;

    virtual std::string GetLocalIp() = 0;

    virtual int GetLocalPort() = 0;

    virtual void ProcessIncomingData(bool asynccall) = 0;

    virtual void ProcessOutgoingData(bool asynccall) = 0;

protected:

private:

};

typedef boost::shared_ptr<Session> SessionPtr;
typedef boost::weak_ptr<Session> SessionRef;

}


#endif // _ESN_SESSION_H_