CreatePeerLocalMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::ProtobufPeerInterface::CreatePeerLocalMessage:

Public Member Functions
	CreatePeerLocalMessage (const char *ini_address, const int32_t ini_send_to_port, const int32_t ini_recv_on_port)
	Constructor with initial values. More...

	CreatePeerLocalMessage ()
	Constructor. More...

	~CreatePeerLocalMessage ()
	Destructor. More...

	CreatePeerLocalMessage (const CreatePeerLocalMessage *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	send_to_port () const
	Get send_to_port value. More...

void	set_send_to_port (const int32_t new_send_to_port)
	Set send_to_port value. More...

size_t	maxlenof_send_to_port () const
	Get maximum length of send_to_port value. More...

int32_t	recv_on_port () const
	Get recv_on_port value. More...

void	set_recv_on_port (const int32_t new_recv_on_port)
	Set recv_on_port value. More...

size_t	maxlenof_recv_on_port () const
	Get maximum length of recv_on_port value. More...

virtual Message *	clone () 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...

Message &	operator= (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 Time *	time_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...

Interface *	interface () 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_t *	data_ts
	data timestamp aliasing pointer More...

Detailed Description

CreatePeerLocalMessage Fawkes BlackBoard Interface Message.

Definition at line 82 of file ProtobufPeerInterface.h.

Constructor & Destructor Documentation

◆ CreatePeerLocalMessage() [1/3]

fawkes::ProtobufPeerInterface::CreatePeerLocalMessage::CreatePeerLocalMessage	(	const char *	ini_address,
		const int32_t	ini_send_to_port,
		const int32_t	ini_recv_on_port
	)

Constructor with initial values.

Parameters

ini_address	initial value for address
ini_send_to_port	initial value for send_to_port
ini_recv_on_port	initial value for recv_on_port

Definition at line 298 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.

◆ CreatePeerLocalMessage() [2/3]

fawkes::ProtobufPeerInterface::CreatePeerLocalMessage::CreatePeerLocalMessage ( )

Constructor.

Definition at line 314 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.

◆ ~CreatePeerLocalMessage()

fawkes::ProtobufPeerInterface::CreatePeerLocalMessage::~CreatePeerLocalMessage ( )

Destructor.

Definition at line 327 of file ProtobufPeerInterface.cpp.

References fawkes::Interface::data_ptr.

◆ CreatePeerLocalMessage() [3/3]

fawkes::ProtobufPeerInterface::CreatePeerLocalMessage::CreatePeerLocalMessage ( const CreatePeerLocalMessage * m )

explicit

Copy constructor.

Parameters

m	message to copy from

Definition at line 335 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::CreatePeerLocalMessage::address ( ) const

Get address value.

IP address or host name

Returns: address value

Definition at line 350 of file ProtobufPeerInterface.cpp.

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

◆ clone()

Message * fawkes::ProtobufPeerInterface::CreatePeerLocalMessage::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 441 of file ProtobufPeerInterface.cpp.

◆ maxlenof_address()

size_t fawkes::ProtobufPeerInterface::CreatePeerLocalMessage::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 360 of file ProtobufPeerInterface.cpp.

◆ maxlenof_recv_on_port()

size_t fawkes::ProtobufPeerInterface::CreatePeerLocalMessage::maxlenof_recv_on_port ( ) const

Get maximum length of recv_on_port value.

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

Definition at line 420 of file ProtobufPeerInterface.cpp.

◆ maxlenof_send_to_port()

size_t fawkes::ProtobufPeerInterface::CreatePeerLocalMessage::maxlenof_send_to_port ( ) const

Get maximum length of send_to_port value.

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

Definition at line 390 of file ProtobufPeerInterface.cpp.

◆ recv_on_port()

int32_t fawkes::ProtobufPeerInterface::CreatePeerLocalMessage::recv_on_port ( ) const

Get recv_on_port value.

Port to receive on

Returns: recv_on_port value

Definition at line 410 of file ProtobufPeerInterface.cpp.

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

◆ send_to_port()

int32_t fawkes::ProtobufPeerInterface::CreatePeerLocalMessage::send_to_port ( ) const

Get send_to_port value.

Port to send to

Returns: send_to_port value

Definition at line 380 of file ProtobufPeerInterface.cpp.

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

◆ set_address()

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

Set address value.

IP address or host name

Parameters

new_address new address value

Definition at line 370 of file ProtobufPeerInterface.cpp.

References fawkes::change_field().

◆ set_recv_on_port()

void fawkes::ProtobufPeerInterface::CreatePeerLocalMessage::set_recv_on_port ( const int32_t new_recv_on_port )

Set recv_on_port value.

Port to receive on

Parameters

new_recv_on_port new recv_on_port value

Definition at line 430 of file ProtobufPeerInterface.cpp.

References fawkes::change_field().

◆ set_send_to_port()

void fawkes::ProtobufPeerInterface::CreatePeerLocalMessage::set_send_to_port ( const int32_t new_send_to_port )

Set send_to_port value.

Port to send to

Parameters

new_send_to_port new send_to_port value

Definition at line 400 of file ProtobufPeerInterface.cpp.

References fawkes::change_field().

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

src/libs/interfaces/ProtobufPeerInterface.h
src/libs/interfaces/ProtobufPeerInterface.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CreatePeerLocalMessage() [1/3]

◆ CreatePeerLocalMessage() [2/3]

◆ ~CreatePeerLocalMessage()

◆ CreatePeerLocalMessage() [3/3]

Member Function Documentation

◆ address()

◆ clone()

◆ maxlenof_address()

◆ maxlenof_recv_on_port()

◆ maxlenof_send_to_port()

◆ recv_on_port()

◆ send_to_port()

◆ set_address()

◆ set_recv_on_port()

◆ set_send_to_port()