vmessage.h

Go to the documentation of this file.

/*
Copyright c1997-2014 Trygve Isaacson. All rights reserved.
This file is part of the Code Vault version 4.1
http://www.bombaydigital.com/
License: MIT. See LICENSE.md in the Vault top level directory.
*/

#ifndef vmessage_h
#define vmessage_h

#include "vtypes.h"
#include "vstring.h"
#include "vbinaryiostream.h"
#include "vmemorystream.h"

class VServer;

typedef Vs32 VMessageLength;    
typedef int  VMessageID;        

#define VLOGGER_MESSAGE_LEVEL(level, message) VLOGGER_NAMED_LEVEL(VMessage::kMessageLoggerName, level, message)

#define VLOGGER_MESSAGE_FATAL(message) VLOGGER_NAMED_FATAL(VMessage::kMessageLoggerName, message)

#define VLOGGER_MESSAGE_ERROR(message) VLOGGER_NAMED_ERROR(VMessage::kMessageLoggerName, message)

#define VLOGGER_MESSAGE_WARN(message) VLOGGER_NAMED_WARN(VMessage::kMessageLoggerName, message)

#define VLOGGER_MESSAGE_INFO(message) VLOGGER_NAMED_INFO(VMessage::kMessageLoggerName, message)

#define VLOGGER_MESSAGE_DEBUG(message) VLOGGER_NAMED_DEBUG(VMessage::kMessageLoggerName, message)

#define VLOGGER_MESSAGE_TRACE(message) VLOGGER_NAMED_TRACE(VMessage::kMessageLoggerName, message)

#define VLOGGER_MESSAGE_HEXDUMP(message, buffer, length) VLOGGER_NAMED_HEXDUMP(VMessage::kMessageLoggerName, VMessage::kMessageContentHexDumpLevel, message, buffer, length)

#define VLOGGER_MESSAGE_WOULD_LOG(level) VLOGGER_NAMED_WOULD_LOG(VMessage::kMessageLoggerName, level)

class VMessage : public VBinaryIOStream {
    public:

        virtual void recycleForSend(VMessageID messageID);
        virtual void recycleForReceive();

        void setMessageID(VMessageID messageID) { mMessageID = messageID; }
        VMessageID getMessageID() const { return mMessageID; }

        virtual void send(const VString& sessionLabel, VBinaryIOStream& out) = 0;
        virtual void receive(const VString& sessionLabel, VBinaryIOStream& in) = 0;
        void copyMessageData(VMessage& targetMessage) const;

        VMessageLength getMessageDataLength() const;
        Vu8* getBuffer() const;
        Vs64 getBufferSize() const;
        /*
        These are the log level definitions used for consistent logging
        of message traffic, processing, and dispatch. Use these
        levels and log to the appropriate logger -- whose name is usually in
        the path form "vault.messages.{classname}.{messageid}" -- in order to
        be consistent in message logging.
        There are issues with some compilers and lazy constant evaluation even
        though these are ints, so we define the actual values in the .cpp file
        separately.

        The format of logged messages should be:
         [session-label] data
        where session-label is:
         id:ip:port
        where id is some descriptive name of the session that does not distinguish which
        client it is (since the ip:port does that)

        Use the macros defined at the top of this file to emit message log output.
        */
        static const VString kMessageLoggerName;
        static const int kMessageContentRecordingLevel; 
        static const int kMessageHeaderLevel;           
        static const int kMessageContentFieldsLevel;    
        static const int kMessageTrafficDetailsLevel;   
        static const int kMessageHandlerDispatchLevel;  
        static const int kMessageHandlerDetailLevel;    
        static const int kMessageContentHexDumpLevel;   
        static const int kMessageQueueOpsLevel;         
        static const int kMessageTraceDetailLevel;      
        static const int kMessageHandlerLifecycleLevel; 

    protected:

        VMessage();
        VMessage(VMessageID messageID, Vs64 initialBufferSize = 1024);
        virtual ~VMessage() {}

        mutable VMemoryStream    mMessageDataBuffer;        

    private:

        VMessage(const VMessage&); // not copyable
        VMessage& operator=(const VMessage&); // not assignable

        VMessageID      mMessageID;             
};

typedef VSharedPtr<VMessage> VMessagePtr;
typedef VSharedPtr<const VMessage> VMessageConstPtr;

class VMessageFactory {
    public:

        VMessageFactory() {}
        virtual ~VMessageFactory() {}

        virtual VMessagePtr instantiateNewMessage(VMessageID messageID = 0) const = 0;
};

#endif /* vmessage_h */