msgaddr.h

Go to the documentation of this file.

/*
 *   Copyright 2014-2015 The 4S Foundation (www.4s-online.dk)
 *
 *   Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */

#ifndef MSGADDR_H
#define MSGADDR_H

#include "handle.h"


namespace FSYS
{

  class MsgSenderBase;
  class MsgQueue;
  template<class parentClass> class MsgAddrGenerator;  

class MsgAddr
{
  // Friend declarations
  template<class parentClass> friend class MsgAddrGenerator;
  friend class MsgSenderBase;
  friend class MsgQueue;

private:
  Handle object;

  Handle queue;

  void * magicKey;

  MsgAddr(Handle object, Handle queue, void * magicKey);

public:
  MsgAddr( void );

  void clear( void );

  bool isValid( void );

  static MsgAddr &broadcastAddr( void );

  inline bool operator==(MsgAddr const &compareTo) const
  {
    return (this->object == compareTo.object)
        && (this->queue == compareTo.queue)
        && (this->magicKey == compareTo.magicKey);
  }

  inline bool operator!=(MsgAddr const &compareTo) const
  {
    return !(*this == compareTo);
  }
};

}


#endif // MSGADDR_H