security_infoton Class Reference

Encapsulates security activities (login, logout, refresh). More...

#include <security_infoton.h>

Inheritance diagram for security_infoton:

Inheritance graph
[legend]
Collaboration diagram for security_infoton:

Collaboration graph
[legend]
List of all members.

Public Types

enum  login_modes { LI_LOGIN, LI_LOGOUT, LI_REFRESH }

Public Member Functions

 security_infoton ()
 security_infoton (login_modes mode, const outcome &success, const byte_array &verification)
 security_infoton (const security_infoton &to_copy)
virtual ~security_infoton ()
 IMPLEMENT_CLASS_NAME ("security_infoton")
security_infotonoperator= (const security_infoton &to_copy)
const byte_arrayverification () const
byte_arrayverification ()
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_arraysecurity_classifier ()
 returns the classifier for this type of infoton.

Public Attributes

login_modes _mode
 what kind of request is being made here?
outcome _success
 did the request succeed?

Detailed Description

Encapsulates security activities (login, logout, refresh).

Definition at line 24 of file security_infoton.h.


Member Enumeration Documentation

enum security_infoton::login_modes

Enumerator:
LI_LOGIN  the requester wants to log in as a new entity.
LI_LOGOUT  the requester surrenders its login.
LI_REFRESH  the requester is still alive and wants to keep its login.

Definition at line 27 of file security_infoton.h.


Constructor & Destructor Documentation

security_infoton::security_infoton (  ) 

Definition at line 27 of file security_infoton.cpp.

security_infoton::security_infoton ( login_modes  mode,
const outcome success,
const byte_array verification 
)

Definition at line 34 of file security_infoton.cpp.

security_infoton::security_infoton ( const security_infoton to_copy  ) 

Definition at line 42 of file security_infoton.cpp.

security_infoton::~security_infoton (  )  [virtual]

Definition at line 51 of file security_infoton.cpp.

References WHACK().


Member Function Documentation

security_infoton::IMPLEMENT_CLASS_NAME ( "security_infoton"   ) 

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

Definition at line 57 of file security_infoton.cpp.

References _mode, _success, _verification, infoton::classifier(), and infoton::set_classifier().

const byte_array & security_infoton::verification (  )  const

Definition at line 67 of file security_infoton.cpp.

Referenced by login_tentacle::consume().

byte_array & security_infoton::verification (  ) 

Definition at line 70 of file security_infoton.cpp.

static const string_array& security_infoton::security_classifier (  )  [static]

returns the classifier for this type of infoton.

Referenced by login_tentacle::reconstitute().

void security_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 84 of file security_infoton.cpp.

References _mode, _success, basis::attach(), and outcome::pack().

bool security_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 91 of file security_infoton.cpp.

References _mode, _success, basis::detach(), and outcome::unpack().

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

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

Implements infoton.

Definition at line 54 of file security_infoton.cpp.

Referenced by login_tentacle::consume().

virtual int security_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

login_modes security_infoton::_mode

what kind of request is being made here?

Definition at line 33 of file security_infoton.h.

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

outcome security_infoton::_success

did the request succeed?

Definition at line 34 of file security_infoton.h.

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


The documentation for this class was generated from the following files:
Generated on Sat Oct 11 04:30:33 2008 for HOOPLE Libraries by  doxygen 1.5.1