Fawkes API  Fawkes Development Version
fawkes::ProtobufPeerInterface::CreatePeerCryptoMessage Class Reference

CreatePeerCryptoMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::ProtobufPeerInterface::CreatePeerCryptoMessage:

Public Member Functions

 CreatePeerCryptoMessage (const char *ini_address, const int32_t ini_port, const char *ini_crypto_key, const char *ini_cipher)
 Constructor with initial values. More...
 
 CreatePeerCryptoMessage ()
 Constructor. More...
 
 ~CreatePeerCryptoMessage ()
 Destructor. More...
 
 CreatePeerCryptoMessage (const CreatePeerCryptoMessage *m)
 Copy constructor. More...
 
char * address () const
 Get address value. More...
 
void set_address (const char *new_address)
 Set address value. More...
 
size_t maxlenof_address () const
 Get maximum length of address value. More...
 
int32_t port () const
 Get port value. More...
 
void set_port (const int32_t new_port)
 Set port value. More...
 
size_t maxlenof_port () const
 Get maximum length of port value. More...
 
char * crypto_key () const
 Get crypto_key value. More...
 
void set_crypto_key (const char *new_crypto_key)
 Set crypto_key value. More...
 
size_t maxlenof_crypto_key () const
 Get maximum length of crypto_key value. More...
 
char * cipher () const
 Get cipher value. More...
 
void set_cipher (const char *new_cipher)
 Set cipher value. More...
 
size_t maxlenof_cipher () const
 Get maximum length of cipher value. More...
 
virtual Messageclone () const
 Clone this message. More...
 
- Public Member Functions inherited from fawkes::Message
 Message (const char *type)
 Constructor. More...
 
 Message (const Message *mesg)
 Copy constructor. More...
 
 Message (const Message &mesg)
 Copy constructor. More...
 
virtual ~Message ()
 Destructor. More...
 
Messageoperator= (const Message &m)
 Assign this message to given message. More...
 
unsigned int id () const
 Get message ID. More...
 
void set_id (unsigned int message_id)
 Set message ID. More...
 
void mark_enqueued ()
 Mark message as being enqueued. More...
 
bool enqueued () const
 Check is message has been enqueued. More...
 
const Timetime_enqueued () const
 Get time when message was enqueued. More...
 
unsigned int sender_id () const
 Get ID of sender. More...
 
const char * sender_thread_name () const
 Get sender of message. More...
 
Interfaceinterface () const
 Get transmitting interface. More...
 
const char * type () const
 Get message type. More...
 
InterfaceFieldIterator fields ()
 Get iterator over all fields of this interface instance. More...
 
InterfaceFieldIterator fields_end ()
 Invalid iterator. More...
 
unsigned int num_fields () const
 Get the number of fields in the message. More...
 
const void * datachunk () const
 Get pointer to data. More...
 
unsigned int datasize () const
 Get size of data. More...
 
unsigned int hops () const
 Get number of hops. More...
 
void set_hops (unsigned int hops)
 Set number of hops. More...
 
void set_from_chunk (const void *chunk)
 Set from raw data chunk. More...
 
unsigned int recipient () const
 Get recipient memory serial. More...
 
template<class MessageType >
bool is_of_type ()
 Check if message has desired type. More...
 
template<class MessageType >
MessageType * as_type ()
 Cast message to given type if possible. More...
 
- Public Member Functions inherited from fawkes::RefCount
 RefCount ()
 Constructor. More...
 
virtual ~RefCount ()
 Destructor. More...
 
void ref ()
 Increment reference count. More...
 
void unref ()
 Decrement reference count and conditionally delete this instance. More...
 
unsigned int refcount ()
 Get reference count for this instance. More...
 

Additional Inherited Members

- Protected Member Functions inherited from fawkes::Message
void add_fieldinfo (interface_fieldtype_t type, const char *name, size_t length, void *value, const char *enumtype=0, const interface_enum_map_t *enum_map=0)
 Add an entry to the info list. More...
 
- Protected Attributes inherited from fawkes::Message
void * data_ptr
 Pointer to memory that contains local data. More...
 
unsigned int data_size
 Size of memory needed to hold all data. More...
 
message_data_ts_tdata_ts
 data timestamp aliasing pointer More...
 

Detailed Description

Constructor & Destructor Documentation

◆ CreatePeerCryptoMessage() [1/3]

fawkes::ProtobufPeerInterface::CreatePeerCryptoMessage::CreatePeerCryptoMessage ( const char *  ini_address,
const int32_t  ini_port,
const char *  ini_crypto_key,
const char *  ini_cipher 
)

Constructor with initial values.

Parameters
ini_addressinitial value for address
ini_portinitial value for port
ini_crypto_keyinitial value for crypto_key
ini_cipherinitial value for cipher

Definition at line 458 of file ProtobufPeerInterface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::IFT_INT32, and fawkes::IFT_STRING.

◆ CreatePeerCryptoMessage() [2/3]

fawkes::ProtobufPeerInterface::CreatePeerCryptoMessage::CreatePeerCryptoMessage ( )

◆ ~CreatePeerCryptoMessage()

fawkes::ProtobufPeerInterface::CreatePeerCryptoMessage::~CreatePeerCryptoMessage ( )

Destructor.

Definition at line 492 of file ProtobufPeerInterface.cpp.

References fawkes::Interface::data_ptr.

◆ CreatePeerCryptoMessage() [3/3]

fawkes::ProtobufPeerInterface::CreatePeerCryptoMessage::CreatePeerCryptoMessage ( const CreatePeerCryptoMessage m)
explicit

Copy constructor.

Parameters
mmessage to copy from

Definition at line 500 of file ProtobufPeerInterface.cpp.

References fawkes::Message::data_ptr, fawkes::Message::data_size, and fawkes::Message::data_ts.

Member Function Documentation

◆ address()

char * fawkes::ProtobufPeerInterface::CreatePeerCryptoMessage::address ( ) const

Get address value.

IP address or host name

Returns
address value

Definition at line 515 of file ProtobufPeerInterface.cpp.

Referenced by protoboard::BlackboardManager::handle_message().

◆ cipher()

char * fawkes::ProtobufPeerInterface::CreatePeerCryptoMessage::cipher ( ) const

Get cipher value.

Cipher name

Returns
cipher value

Definition at line 605 of file ProtobufPeerInterface.cpp.

Referenced by protoboard::BlackboardManager::handle_message().

◆ clone()

Message * fawkes::ProtobufPeerInterface::CreatePeerCryptoMessage::clone ( ) const
virtual

Clone this message.

Produces a message of the same type as this message and copies the data to the new message.

Returns
clone of this message

Reimplemented from fawkes::Message.

Definition at line 636 of file ProtobufPeerInterface.cpp.

◆ crypto_key()

char * fawkes::ProtobufPeerInterface::CreatePeerCryptoMessage::crypto_key ( ) const

Get crypto_key value.

Crypto key

Returns
crypto_key value

Definition at line 575 of file ProtobufPeerInterface.cpp.

Referenced by protoboard::BlackboardManager::handle_message().

◆ maxlenof_address()

size_t fawkes::ProtobufPeerInterface::CreatePeerCryptoMessage::maxlenof_address ( ) const

Get maximum length of address value.

Returns
length of address value, can be length of the array or number of maximum number of characters for a string

Definition at line 525 of file ProtobufPeerInterface.cpp.

◆ maxlenof_cipher()

size_t fawkes::ProtobufPeerInterface::CreatePeerCryptoMessage::maxlenof_cipher ( ) const

Get maximum length of cipher value.

Returns
length of cipher value, can be length of the array or number of maximum number of characters for a string

Definition at line 615 of file ProtobufPeerInterface.cpp.

◆ maxlenof_crypto_key()

size_t fawkes::ProtobufPeerInterface::CreatePeerCryptoMessage::maxlenof_crypto_key ( ) const

Get maximum length of crypto_key value.

Returns
length of crypto_key value, can be length of the array or number of maximum number of characters for a string

Definition at line 585 of file ProtobufPeerInterface.cpp.

◆ maxlenof_port()

size_t fawkes::ProtobufPeerInterface::CreatePeerCryptoMessage::maxlenof_port ( ) const

Get maximum length of port value.

Returns
length of port value, can be length of the array or number of maximum number of characters for a string

Definition at line 555 of file ProtobufPeerInterface.cpp.

◆ port()

int32_t fawkes::ProtobufPeerInterface::CreatePeerCryptoMessage::port ( ) const

Get port value.

Port to send to/receive on

Returns
port value

Definition at line 545 of file ProtobufPeerInterface.cpp.

Referenced by protoboard::BlackboardManager::handle_message().

◆ set_address()

void fawkes::ProtobufPeerInterface::CreatePeerCryptoMessage::set_address ( const char *  new_address)

Set address value.

IP address or host name

Parameters
new_addressnew address value

Definition at line 535 of file ProtobufPeerInterface.cpp.

References fawkes::change_field().

◆ set_cipher()

void fawkes::ProtobufPeerInterface::CreatePeerCryptoMessage::set_cipher ( const char *  new_cipher)

Set cipher value.

Cipher name

Parameters
new_ciphernew cipher value

Definition at line 625 of file ProtobufPeerInterface.cpp.

References fawkes::change_field().

◆ set_crypto_key()

void fawkes::ProtobufPeerInterface::CreatePeerCryptoMessage::set_crypto_key ( const char *  new_crypto_key)

Set crypto_key value.

Crypto key

Parameters
new_crypto_keynew crypto_key value

Definition at line 595 of file ProtobufPeerInterface.cpp.

References fawkes::change_field().

◆ set_port()

void fawkes::ProtobufPeerInterface::CreatePeerCryptoMessage::set_port ( const int32_t  new_port)

Set port value.

Port to send to/receive on

Parameters
new_portnew port value

Definition at line 565 of file ProtobufPeerInterface.cpp.

References fawkes::change_field().


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