common/message.cc

Go to the documentation of this file.

// -*- C++ -*-

// message.cc - This class defines a message that is 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 *****

#include "exceptions.h"
#include "message.h"
#include "guard.h"

const char * const Message::MT_names[] = {
    "M_Data",
    "M_Command",
    "M_Request",
    "M_Response",
};

Message::Message(const u_char *data, size_t len)
    : msg_type(M_Data), cmd_code(C_None), req_class(R_None),
      privdata(const_cast<u_char*>(data)), length(len)
{
    Guard::initialize_mutex(mutex);
}

Message::Message(CmdCode code)
    : msg_type(M_Command), cmd_code(code), req_class(R_None),
      privdata(NULL), length(0)
{
    Guard::initialize_mutex(mutex);
}

Message::Message(MsgType type, ReqVal req, u_char *data = NULL, size_t len = 0)
    : msg_type(type), cmd_code(C_None), req_class(req),
      privdata(data), length(len)
{
    Guard::initialize_mutex(mutex);
}

Message::~Message(void)
{
    return;
}

const char *
Message::name(void) const
{
    return(MT_names[this->msg_type]);
}

const u_char *
Data::data(void) const
{
    return privdata;
}

size_t
Data::len(void) const
{
    return length;
}

void
Message::alloc_data(const size_t size)
{
    if (privdata)
        throw CMUnsupported("Unable to re-allocate a Message object contents");
    privdata = new unsigned char [size];
    /* Can new fail without throwing an exception? */
    length = size;
    return;
}

void
Message::Lock(void)
{
    int ret = pthread_mutex_lock(&this->mutex);
    PTHREAD_CHECK_AND_THROW(ret, "mutex_lock(Message::mutex)");
#if     EXTRA_MUTEX_STATE_LOGGING
    clog << "Message::Lock locked a message at " << this << endl;
#endif  /* EXTRA_MUTEX_STATE_LOGGING */
}

void
Message::Unlock(void)
{
    int ret = pthread_mutex_unlock(&this->mutex);
    PTHREAD_CHECK_AND_THROW(ret, "mutex_unlock(Message::mutex)");
#if     EXTRA_MUTEX_STATE_LOGGING
    clog << "Message::Unlock UNlocked a message at " << this << endl;
#endif  /* EXTRA_MUTEX_STATE_LOGGING */
}

/* A "deep" copy constructor for Data */
Data::Data(const Data &orig) : Message(NULL,0)
{
    this->alloc_data(orig.len());
    (void)memmove(privdata, orig.data(), orig.len());
    return;
}

std::ostream &
operator<<(std::ostream &out, const Data &blob)
{
    /* It's very annoying that ostream::write() won't take an */
    /* unsigned char*... */
    out.write(reinterpret_cast<const char*>(blob.data()), blob.len());

    return(out);
}

---