Data structure of a ControlHost message. More...

Inheritance diagram for JNET::JDispatch:

Public Types
typedef JMalloc< char >	JMemory_t

Public Member Functions
	JDispatch ()
	Default constructor.

	JDispatch (const JPrefix_t &prefix, const char *data)
	Constructor.

	JDispatch (const JTag &tag, const std::string &message)
	Constructor.

	JDispatch (const JDispatch &message)
	Copy constructor.

	~JDispatch ()
	Destructor.

JDispatch &	operator= (const JDispatch &message)
	Assignment operator.

	operator JSocketOutputBuffer () const
	Type conversion operator.

int	size () const
	Get size.

const char *	data () const
	Get data.

int	getSize () const
	Get size.

void	setSize (const long long int length)
	Set size.

void	set (const JTag &tag, const long long int length)
	Set prefix.

const JTag &	getTag () const
	Get tag.

JTag &	getTag ()
	Get tag.

void	setTag (const JTag &tag)
	Set tag.

void	setTag (const std::string &tag)
	Set tag.

void	setTag (const JTag_t id)
	Set tag.

JTag_t	getID () const
	Get identifier.

std::string	toString () const
	Convert tag to string.

	operator std::string () const
	Type conversion operators.

const char *	c_str () const
	C-string.

const char	operator[] (int i) const
	Get character.

void	initialise ()
	Initialise counter.

void	attach (const JSharedCounter &object)
	Attach this counter to given shared counter object.

bool	detach ()
	Detach.

const int	getCount ()
	Get count.

Static Public Attributes
static long long int	MEMORY_TOTAL = 0
	Total size of data [Bytes].

static long long int	MEMORY_LIMIT
	Limit size of data [Bytes].

Protected Member Functions
void	create ()
	Allocate memory.

void	release ()
	Release memory.

Protected Attributes
char *	buffer

long long int	size

JTag_t	id

int *	counter

Detailed Description

Data structure of a ControlHost message.

This data structure consists of a copy of the ControlHost prefix and an array of bytes (including the ControlHost prefix). A new array of bytes is created by the appropriate constructor. The allocated memory is released upon destruction of the last object of this class.

Definition at line 64 of file JLigier.cc.

Member Typedef Documentation

◆ JMemory_t

JMalloc<char> JNET::JDispatch::JMemory_t

Definition at line 70 of file JLigier.cc.

Constructor & Destructor Documentation

◆ JDispatch() [1/4]

JNET::JDispatch::JDispatch ( )

inline

Default constructor.

Definition at line 78 of file JLigier.cc.

                :
      JPrefix_t(),
      JSharedCounter(),
      buffer(NULL)
    {}

◆ JDispatch() [2/4]

JNET::JDispatch::JDispatch	(	const JPrefix_t &	prefix,
		const char *	data )

inline

Constructor.

Note that the input data should contain a copy of the prefix.

Parameters

prefix	prefix
data	data

Definition at line 92 of file JLigier.cc.

                                     :
      JPrefix_t(prefix),
      JSharedCounter()
    {
      create();
 
      memcpy(this->buffer, data, size());
    }

◆ JDispatch() [3/4]

JNET::JDispatch::JDispatch	(	const JTag &	tag,
		const std::string &	message )

inline

Constructor.

Note that the given message is appended to a copy of the prefix.

Parameters

tag	tag
message	message

Definition at line 110 of file JLigier.cc.

                                        :
      JPrefix_t(tag, message.size()),
      JSharedCounter()
    {
      create();
      
      memcpy(this->buffer, static_cast<const JPrefix_t*>(this), sizeof(JPrefix_t));
 
      memcpy(this->buffer + sizeof(JPrefix_t), message.data(), message.size());
    }

◆ JDispatch() [4/4]

JNET::JDispatch::JDispatch ( const JDispatch & message )

inline

Copy constructor.

Parameters

message message

Definition at line 128 of file JLigier.cc.

    {
      static_cast<JPrefix_t&>(*this) = message;
 
      buffer = message.buffer;
 
      attach(message);
    }

◆ ~JDispatch()

JNET::JDispatch::~JDispatch ( )

inline

Destructor.

Definition at line 141 of file JLigier.cc.

    {
      if (detach()) {
        release();
      }
    }

Member Function Documentation

◆ operator=()

JDispatch & JNET::JDispatch::operator= ( const JDispatch & message )

inline

Assignment operator.

Parameters

message message

Returns: this JDispatch

Definition at line 155 of file JLigier.cc.

    {
      if (buffer != message.buffer) {
 
        if (detach()) {
          release();
        }
        
        buffer = message.buffer;
 
        attach(message);
      }
 
      return *this;
    }

◆ operator JSocketOutputBuffer()

JNET::JDispatch::operator JSocketOutputBuffer ( ) const

inline

Type conversion operator.

Returns: socket output buffer

Definition at line 177 of file JLigier.cc.

    {
      return JSocketOutputBuffer(this->data(), this->size());
    }

◆ size()

int JNET::JDispatch::size ( ) const

inline

Get size.

Returns: number of bytes

Definition at line 188 of file JLigier.cc.

    {
      return getSizeOfPacket(static_cast<const JPrefix_t&>(*this));
    }

◆ data()

const char * JNET::JDispatch::data ( ) const

inline

Get data.

Returns: pointer to data

Definition at line 199 of file JLigier.cc.

    {
      return buffer;
    }

◆ create()

void JNET::JDispatch::create ( )

inlineprotected

Allocate memory.

Definition at line 209 of file JLigier.cc.

    {
      buffer = JMemory_t::create(size());
        
      if (buffer != NULL) {
 
        JSharedCounter::initialise();
        
        MEMORY_TOTAL += size();
 
      } else {
 
        throw JMallocException("Not enough space in memory.");
      }
    }

◆ release()

void JNET::JDispatch::release ( )

inlineprotected

Release memory.

Definition at line 229 of file JLigier.cc.

    {
      JMemory_t::release(buffer);
 
      MEMORY_TOTAL -= size();
    }

◆ getSize()

int JNET::JPrefix::getSize ( ) const

inlineinherited

Get size.

Returns: number of bytes

Definition at line 62 of file JPrefix.hh.

    {
      return ntohl(size);
    }

◆ setSize()

void JNET::JPrefix::setSize ( const long long int length )

inlineinherited

Set size.

Parameters

length number of bytes

Definition at line 73 of file JPrefix.hh.

    {
      size = htonl(length);
    }

◆ set()

void JNET::JPrefix::set	(	const JTag &	tag,
		const long long int	length )

inlineinherited

Set prefix.

Parameters

tag	tag
length	number of bytes

Definition at line 85 of file JPrefix.hh.

    {
      setTag (tag);
      setSize(length);
    }

◆ getTag() [1/2]

const JTag & JNET::JTag::getTag ( ) const

inlineinherited

Get tag.

Returns: tag

Definition at line 86 of file JTag.hh.

    {
      return static_cast<const JTag&>(*this);
    }

◆ getTag() [2/2]

JTag & JNET::JTag::getTag ( )

inlineinherited

Get tag.

Returns: tag

Definition at line 97 of file JTag.hh.

    {
      return static_cast<JTag&>(*this);
    }

◆ setTag() [1/3]

void JNET::JTag::setTag ( const JTag & tag )

inlineinherited

Set tag.

Parameters

tag tag

Definition at line 108 of file JTag.hh.

    {
      id = tag.getID();
    }

◆ setTag() [2/3]

void JNET::JTag::setTag ( const std::string & tag )

inlineinherited

Set tag.

This method may throw an exception.

Parameters

tag tag

Definition at line 121 of file JTag.hh.

    {
      if (!tag.empty() && tag.size() <= TAGSIZE) {
        
        char* __p = (char*) &(this->id);
 
        size_t i = 0;
 
        for ( ; i != tag.size(); ++i) {
          __p[i] = tag[i];
        }
 
        for ( ; i != TAGSIZE;    ++i) {
          __p[i] = '\0';
        }
 
      } else {
 
        THROW(JControlHostException, "Invalid tag length <" << tag << "> " << tag.size());
      }
    }

◆ setTag() [3/3]

void JNET::JTag::setTag ( const JTag_t id )

inlineinherited

Set tag.

Parameters

id	identifier

Definition at line 149 of file JTag.hh.

    { 
      this->id = id;
    }

◆ getID()

JTag_t JNET::JTag::getID ( ) const

inlineinherited

Get identifier.

Returns: identifier

Definition at line 160 of file JTag.hh.

    { 
      return id;
    }

◆ toString()

std::string JNET::JTag::toString ( ) const

inlineinherited

Convert tag to string.

Returns: tag

Definition at line 171 of file JTag.hh.

    {
      int pos = TAGSIZE;
 
      const char* __p = (const char*) &(this->id);
      
      while (pos != 0 && __p[pos-1] == '\0') {
        --pos;
      }
 
      return std::string(__p, pos);
    }

◆ operator std::string()

JNET::JTag::operator std::string ( ) const

inlineinherited

Type conversion operators.

Returns: tag

Definition at line 190 of file JTag.hh.

    {
      return toString();
    }

◆ c_str()

const char * JNET::JTag::c_str ( ) const

inlineinherited

C-string.

Returns: tag

Definition at line 201 of file JTag.hh.

    {
      return (const char*) &(this->id);
    }

◆ operator[]()

const char JNET::JTag::operator[] ( int i ) const

inlineinherited

Get character.

Parameters

i index

Returns: character at index

Definition at line 213 of file JTag.hh.

    {
      const char* __p = (const char*) &(this->id);
 
      return __p[i];
    }

◆ initialise()

void JLANG::JSharedCounter::initialise ( )

inlineinherited

Initialise counter.

Definition at line 33 of file JSharedCounter.hh.

    {
      detach();
 
      counter = new int(1);
    }

◆ attach()

void JLANG::JSharedCounter::attach ( const JSharedCounter & object )

inlineinherited

Attach this counter to given shared counter object.

Parameters

object shared counter

Definition at line 46 of file JSharedCounter.hh.

    {
      detach();
 
      counter = object.counter;
 
      if (counter != NULL) {
        ++(*counter);
      }
    }

◆ detach()

bool JLANG::JSharedCounter::detach ( )

inlineinherited

Detach.

Returns: true if counter at zero; else false

Definition at line 63 of file JSharedCounter.hh.

    {
      if (counter != NULL) {
 
        if (--(*counter) == 0) {
 
          delete counter;
 
          counter = NULL;
 
          return true;
        }
 
        counter = NULL;
      }
 
      return false;
    }

◆ getCount()

const int JLANG::JSharedCounter::getCount ( )

inlineinherited

Get count.

Returns: count

Definition at line 88 of file JSharedCounter.hh.

    {
      return (counter != NULL ? *counter : 0);
    }

Member Data Documentation

◆ MEMORY_TOTAL

long long int JNET::JDispatch::MEMORY_TOTAL = 0

static

Total size of data [Bytes].

Total memory allocation.

Definition at line 72 of file JLigier.cc.

◆ MEMORY_LIMIT

long long int JNET::JDispatch::MEMORY_LIMIT

static

Limit size of data [Bytes].

Limit memory allocation.

Definition at line 73 of file JLigier.cc.

◆ buffer

char* JNET::JDispatch::buffer

protected

Definition at line 236 of file JLigier.cc.

◆ size

long long int JNET::JPrefix::size

protectedinherited

Definition at line 92 of file JPrefix.hh.

◆ id

JTag_t JNET::JTag::id

protectedinherited

Definition at line 254 of file JTag.hh.

◆ counter

int* JLANG::JSharedCounter::counter

protectedinherited

Definition at line 94 of file JSharedCounter.hh.

The documentation for this class was generated from the following file:

JLigier.cc

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ JMemory_t

Constructor & Destructor Documentation

◆ JDispatch() [1/4]

◆ JDispatch() [2/4]

◆ JDispatch() [3/4]

◆ JDispatch() [4/4]

◆ ~JDispatch()

Member Function Documentation

◆ operator=()

◆ operator JSocketOutputBuffer()

◆ size()

◆ data()

◆ create()

◆ release()

◆ getSize()

◆ setSize()

◆ set()

◆ getTag() [1/2]

◆ getTag() [2/2]

◆ setTag() [1/3]

◆ setTag() [2/3]

◆ setTag() [3/3]

◆ getID()

◆ toString()

◆ operator std::string()

◆ c_str()

◆ operator[]()

◆ initialise()

◆ attach()

◆ detach()

◆ getCount()

Member Data Documentation

◆ MEMORY_TOTAL

◆ MEMORY_LIMIT

◆ buffer

◆ size

◆ id

◆ counter