identity_infoton Class Reference

Encapsulates just the action of identifying an octopus user. More...

#include <identity_infoton.h>

Inheritance diagram for identity_infoton:

Inheritance graph
[legend]
Collaboration diagram for identity_infoton:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 identity_infoton ()
 identity_infoton (const octopus_entity &name)
 identity_infoton (const identity_infoton &to_copy)
virtual ~identity_infoton ()
 IMPLEMENT_CLASS_NAME ("identity_infoton")
identity_infotonoperator= (const identity_infoton &to_copy)
virtual void pack (byte_array &packed_form) const
 stuffs the data in the infoton into the "packed_form".
virtual bool unpack (byte_array &packed_form)
 restores an infoton from a packed form.
virtual clonableclone () const
 must be provided to allow creation of a copy of this object.
virtual int packed_size () const
 reports how large the infoton will be when packed.

Static Public Member Functions

static const string_arrayidentity_classifier ()
 returns the classifier for this type of infoton.

Public Attributes

octopus_entity _new_name

Detailed Description

Encapsulates just the action of identifying an octopus user.

This must be done for an entity before it can begin to request octopus services when there is strong security in place. By default, the octopus does not require this.

Definition at line 28 of file identity_infoton.h.


Constructor & Destructor Documentation

identity_infoton::identity_infoton (  ) 

Definition at line 26 of file identity_infoton.cpp.

identity_infoton::identity_infoton ( const octopus_entity name  ) 

Definition at line 31 of file identity_infoton.cpp.

identity_infoton::identity_infoton ( const identity_infoton to_copy  ) 

Definition at line 36 of file identity_infoton.cpp.

identity_infoton::~identity_infoton (  )  [virtual]

Definition at line 42 of file identity_infoton.cpp.


Member Function Documentation

identity_infoton::IMPLEMENT_CLASS_NAME ( "identity_infoton"   ) 

identity_infoton & identity_infoton::operator= ( const identity_infoton to_copy  ) 

Definition at line 44 of file identity_infoton.cpp.

References _new_name, infoton::classifier(), and infoton::set_classifier().

static const string_array& identity_infoton::identity_classifier (  )  [static]

returns the classifier for this type of infoton.

Referenced by identity_tentacle::reconstitute().

void identity_infoton::pack ( byte_array packed_form  )  const [virtual]

stuffs the data in the infoton into the "packed_form".

the derived method must know how to pack this particular type of infoton.

Implements infoton.

Definition at line 62 of file identity_infoton.cpp.

References _new_name, and octopus_entity::pack().

bool identity_infoton::unpack ( byte_array packed_form  )  [virtual]

restores an infoton from a packed form.

the unpack() method will be utilized by tentacles that support this type of object.

Implements infoton.

Definition at line 65 of file identity_infoton.cpp.

References _new_name, and octopus_entity::unpack().

clonable * identity_infoton::clone (  )  const [virtual]

must be provided to allow creation of a copy of this object.

Implements infoton.

Definition at line 59 of file identity_infoton.cpp.

Referenced by identity_tentacle::consume().

virtual int identity_infoton::packed_size (  )  const [virtual]

reports how large the infoton will be when packed.

must be overridden by derived classes to provide a guess at how large the packed size of this will be. this is important to estimate accurately.

Implements infoton.


Member Data Documentation

octopus_entity identity_infoton::_new_name

Definition at line 31 of file identity_infoton.h.

Referenced by identity_tentacle::consume(), operator=(), pack(), and unpack().


The documentation for this class was generated from the following files:
Generated on Fri Aug 29 04:30:32 2008 for HOOPLE Libraries by  doxygen 1.5.1