common/message.h

Go to the documentation of this file.

// -*- C++ -*-

/* \file message.h
 * This file declares the Message class.  These objects are meant to
 * be sent either between threads or between processes (connected
 * via UDS or TCP sockets, or what-have-you). */

// ***** BEGIN LICENSE BLOCK *****
// Version: MPL 1.1/GPL 2.0/LGPL 2.1
// 
// The contents of this file are subject to the Mozilla Public License
// Version 1.1 (the "License"); you may not use this file except in
// compliance with the License. You may obtain a copy of the License at
// http://www.mozilla.org/MPL/
// 
// Software distributed under the License is distributed on an "AS IS"
// basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
// the License for the specific language governing rights and limitations
// under the License.
// 
// The Original Code is the consmgr network/serial-line monitoring package.
// 
// The Initial Developer of the Original Code is Chris P. Ross.
// Portions created by the Initial Developer are Copyright (C) 2000-2008
// the Initial Developer.  All Rights Reserved.
// 
// Contributor(s):
// 
// Alternatively, the contents of this file may be used under the terms of
// either the GNU General Public License Version 2 or later (the "GPL"), or
// the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
// in which case the provisions of the GPL or the LGPL are applicable instead
// of those above. If you wish to allow use of your version of this file only
// under the terms of either the GPL or the LGPL, and not to allow others to
// use your version of this file under the terms of the MPL, indicate your
// decision by deleting the provisions above and replace them with the notice
// and other provisions required by the GPL or the LGPL. If you do not delete
// the provisions above, a recipient may use your version of this file under
// the terms of any one of the MPL, the GPL or the LGPL.
// 
// ***** END LICENSE BLOCK *****

#ifndef __MESSAGE_H
#define __MESSAGE_H

#include <sys/types.h>

#include <loki/SmartPtr.h>

class Message
{
  public:
    typedef enum {
        M_Data = 0,             
        M_Command = 1,          
        M_Request = 2,          
        M_Response = 3,         
    }                   MsgType;

    typedef enum {
        C_None = 0, C_Exit, C_Disconnected,
    }                   CmdCode;

    typedef enum {
        R_None = 0, R_Status, R_History,
    }                   ReqVal;

    Message(CmdCode);                           
    Message(MsgType, ReqVal, u_char*, size_t);  
    virtual ~Message();

    const MsgType       type(void) const        { return(msg_type); }
    const CmdCode       code(void) const        { return(cmd_code); }
    const char *        name(void) const;

    void                Lock(void);
    void                Unlock(void);

  protected:
    Message(const u_char *, size_t);

  private:
    MsgType             msg_type;
    CmdCode             cmd_code;
    ReqVal              req_class;

  protected:
    void                alloc_data(const size_t size);
        
    unsigned char *     privdata;               
    size_t              length;                 

  private:
    pthread_mutex_t     mutex;

    static const char * const MT_names[];
        
    // Make construction and copying unavailable
    Message(const Message&);
    Message & operator=(const Message&);
};

typedef Loki::SmartPtr<Message,
            Loki::RefCountedMTAdj<Loki::ObjectLevelLockable>::RefCountedMT,
            Loki::DisallowConversion,   // The default
            Loki::AssertCheck,          // The default
            Loki::LockedStorage>
        MessageP;

class Data : public Message
{
  public:
    Data(u_char *d, size_t l) : Message(d,l) {}

    /* Copy constructor, which will do a "deep copy". Should */
    /* be used sparingly and/or carefully. */
    Data(const Data &d);

    /* Utility constructor to build a data object from a std::string */
    Data(const std::string &s) : Message(reinterpret_cast<const u_char*>(s.c_str()),s.length()) {}

    virtual ~Data() {}

    const u_char *      data(void) const;    
    size_t              len(void) const;
};

std::ostream & operator <<(std::ostream &out, const Data &blob);

#endif  /* __MESSAGE_H */

---