JNET::JPrefix Class Reference

ControlHost prefix. More...

#include <JPrefix.hh>

Inheritance diagram for JNET::JPrefix:

Public Member Functions
	JPrefix ()
	Default constructor. More...
	JPrefix (const JTag &tag, const long long int length)
	Constructor. More...
int	getSize () const
	Get size. More...
void	setSize (const long long int length)
	Set size. More...
void	set (const JTag &tag, const long long int length)
	Set prefix. More...
const JTag &	getTag () const
	Get tag. More...
JTag &	getTag ()
	Get tag. More...
void	setTag (const JTag &tag)
	Set tag. More...
void	setTag (const std::string &tag)
	Set tag. More...
void	setTag (const JTag_t id)
	Set tag. More...
JTag_t	getID () const
	Get identifier. More...
std::string	toString () const
	Convert tag to string. More...
	operator std::string () const
	Type conversion operators. More...
const char *	c_str () const
	C-string. More...
const char	operator[] (int i) const
	Get character. More...

Protected Attributes
long long int	size
JTag_t	id

Detailed Description

ControlHost prefix.

The ControlHost prefix is a light-weight data structure which consists of a tag and a length. The length is converted to network byte order and vice versa, using methods setSize() and getSize(), respectively.

Definition at line 31 of file JPrefix.hh.

Constructor & Destructor Documentation

JPrefix() [1/2]

JNET::JPrefix::JPrefix ( )

inline

Default constructor.

Definition at line 38 of file JPrefix.hh.

              :
      JTag(),
      size(0)
    {}

JPrefix() [2/2]

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

inline

Constructor.

Parameters

tag	tag
length	number of bytes

Definition at line 50 of file JPrefix.hh.

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

Member Function Documentation

getSize()

int JNET::JPrefix::getSize ( ) const

inline

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 )

inline

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  )

inline

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];
    }

Member Data Documentation

size

long long int JNET::JPrefix::size

protected

Definition at line 92 of file JPrefix.hh.

id

JTag_t JNET::JTag::id

protectedinherited

Definition at line 254 of file JTag.hh.

---

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

• JPrefix.hh