feisty meow concerns codebase  2.140
identity_infoton.h
Go to the documentation of this file.
1 #ifndef IDENTITY_INFOTON_CLASS
2 #define IDENTITY_INFOTON_CLASS
3 
4 /*****************************************************************************\
5 * *
6 * Name : identity_infoton *
7 * Author : Chris Koeritz *
8 * *
9 *******************************************************************************
10 * Copyright (c) 2002-$now By Author. This program is free software; you can *
11 * redistribute it and/or modify it under the terms of the GNU General Public *
12 * License as published by the Free Software Foundation; either version 2 of *
13 * the License or (at your option) any later version. This is online at: *
14 * http://www.fsf.org/copyleft/gpl.html *
15 * Please send any updates to: fred@gruntose.com *
16 \*****************************************************************************/
17 
18 #include "entity_defs.h"
19 #include "infoton.h"
20 
21 namespace octopi {
22 
24 
30 class identity_infoton : public infoton
31 {
32 public:
34 
36  identity_infoton(const octopus_entity &name);
37  identity_infoton(const identity_infoton &to_copy);
38 
39  virtual ~identity_infoton();
40 
41  DEFINE_CLASS_NAME("identity_infoton");
42 
44 
47 
48  virtual void text_form(basis::base_string &fill) const;
49 
50  virtual int packed_size() const;
51  virtual void pack(basis::byte_array &packed_form) const;
52  virtual bool unpack(basis::byte_array &packed_form);
53 
54  virtual clonable *clone() const;
55 };
56 
57 } //namespace.
58 
59 #endif
60 
Defines the base class for all string processing objects in hoople.
Definition: base_string.h:28
A very common template for a dynamic array of bytes.
Definition: byte_array.h:36
Encapsulates just the action of identifying an octopus user.
virtual clonable * clone() const
must be provided to allow creation of a copy of this object.
static const structures::string_array & identity_classifier()
returns the classifier for this type of infoton.
identity_infoton & operator=(const identity_infoton &to_copy)
virtual bool unpack(basis::byte_array &packed_form)
restores an infoton from a packed form.
virtual void pack(basis::byte_array &packed_form) const
stuffs the data in the infoton into the "packed_form".
virtual int packed_size() const
reports how large the infoton will be when packed.
DEFINE_CLASS_NAME("identity_infoton")
An infoton is an individual request parcel with accompanying information.
Definition: infoton.h:32
virtual basis::astring text_form() const
local version just makes text_form() more functional.
Definition: infoton.h:108
Provides a way of identifying users of an octopus object.
Definition: entity_defs.h:35
An array of strings with some additional helpful methods.
Definition: string_array.h:32