OpenPRS protobuf integration class. More...

#include "oprs_protobuf.h"

Public Member Functions
	OpenPRSProtobuf (std::vector< std::string > &proto_path)
	Constructor. More...

	~OpenPRSProtobuf ()
	Destructor. More...

protobuf_comm::ProtobufStreamServer *	server () const
	Get Protobuf server. More...

const std::map< long int, protobuf_comm::ProtobufBroadcastPeer * > &	peers () const
	Get protobuf_comm peers. More...

protobuf_comm::MessageRegister &	message_register ()
	Get the communicator's message register. More...

boost::signals2::signal< void(protobuf_comm::ProtobufStreamServer::ClientID, std::shared_ptr< google::protobuf::Message >)> &	signal_server_sent ()
	Signal invoked for a message that has been sent to a server client. More...

boost::signals2::signal< void(std::string, unsigned short, std::shared_ptr< google::protobuf::Message >)> &	signal_client_sent ()
	Signal invoked for a message that has been sent to a client. More...

boost::signals2::signal< void(long int, std::shared_ptr< google::protobuf::Message >)> &	signal_peer_sent ()
	Signal invoked for a message that has been sent via broadcast. More...

bool	oprs_pb_register_type (std::string full_name)
	Register a new message type. More...

Term *	oprs_pb_field_names (void *msgptr)
	Get field names of message. More...

bool	oprs_pb_has_field (void *msgptr, std::string field_name)
	Check if message has a specific field. More...

Term *	oprs_pb_field_value (void *msgptr, std::string field_name)
	Get properly typed field value. More...

Term *	oprs_pb_field_type (void *msgptr, std::string field_name)
	Get type if a specific field. More...

Term *	oprs_pb_field_label (void *msgptr, std::string field_name)
	Get a fields label. More...

Term *	oprs_pb_field_list (void *msgptr, std::string field_name)
	Get list of values of a given message field. More...

bool	oprs_pb_field_is_list (void *msgptr, std::string field_name)
	Check if a given field is a list (repeated field). More...

std::shared_ptr< google::protobuf::Message > *	oprs_create_msg (std::string full_name)
	Create a new message of given type. More...

Term *	oprs_pb_ref (void *msgptr)
	Create new reference to message. More...

Term *	oprs_pb_destroy (void *msgptr)
	Destroy given message (reference). More...

void	oprs_pb_set_field (void msgptr, std::string field_name, Term value)
	Set a field. More...

void	oprs_pb_add_list (void msgptr, std::string field_name, Term value)
	Add value to a repeated field. More...

void	oprs_pb_send (long int client_id, void *msgptr)
	Send message to a specific client. More...

Term *	oprs_pb_client_connect (std::string host, int port)
	Connect as a client to the given server. More...

void	oprs_pb_disconnect (long int client_id)
	Disconnect a given client. More...

void	oprs_pb_broadcast (long int peer_id, void *msgptr)
	Broadcast a message through a peer. More...

void	oprs_pb_enable_server (int port)
	Enable protobuf stream server. More...

void	oprs_pb_disable_server ()
	Disable protobuf stream server. More...

Term *	oprs_pb_peer_create (std::string host, int port)
	Enable protobuf peer. More...

Term *	oprs_pb_peer_create_local (std::string host, int send_port, int recv_port)
	Enable protobuf peer. More...

Term *	oprs_pb_peer_create_crypto (std::string host, int port, std::string crypto_key="", std::string cipher="")
	Enable protobuf peer. More...

Term *	oprs_pb_peer_create_local_crypto (std::string host, int send_port, int recv_port, std::string crypto_key="", std::string cipher="")
	Enable protobuf peer. More...

void	oprs_pb_peer_destroy (long int peer_id)
	Disable peer. More...

void	oprs_pb_peer_setup_crypto (long int peer_id, std::string crypto_key, std::string cipher)
	Setup crypto for peer. More...

bool	oprs_pb_events_pending ()
	Check if there are pending events. More...

void	oprs_pb_process ()
	Process all pending events. More...

Detailed Description

OpenPRS protobuf integration class.

This class adds functionality related to protobuf to OpenPRS. It supports the creation of communication channels through protobuf_comm. An instance maintains its own message register shared among server, peer, and clients.

Author: Tim Niemueller

Definition at line 60 of file oprs_protobuf.h.

Constructor & Destructor Documentation

◆ OpenPRSProtobuf()

oprs_protobuf::OpenPRSProtobuf::OpenPRSProtobuf ( std::vector< std::string > & proto_path )

Constructor.

Parameters

proto_path proto path passed to a newly instantiated message register

Definition at line 70 of file oprs_protobuf.cpp.

◆ ~OpenPRSProtobuf()

oprs_protobuf::OpenPRSProtobuf::~OpenPRSProtobuf ( )

Destructor.

Definition at line 78 of file oprs_protobuf.cpp.

Member Function Documentation

◆ message_register()

protobuf_comm::MessageRegister& oprs_protobuf::OpenPRSProtobuf::message_register ( )

inline

Get the communicator's message register.

Returns: message register

Definition at line 79 of file oprs_protobuf.h.

◆ oprs_create_msg()

std::shared_ptr< google::protobuf::Message > * oprs_protobuf::OpenPRSProtobuf::oprs_create_msg ( std::string full_name )

Create a new message of given type.

Parameters

full_name name of message type (fully qualified, i.e. including package name)

Returns: shared pointer to new mesage

Exceptions

std::runtime_error thrown if creating the message failed

Definition at line 251 of file oprs_protobuf.cpp.

References protobuf_comm::MessageRegister::new_message_for().

◆ oprs_pb_add_list()

void oprs_protobuf::OpenPRSProtobuf::oprs_pb_add_list	(	void *	msgptr,
		std::string	field_name,
		Term *	value
	)

Add value to a repeated field.

Parameters

msgptr	message
field_name	name of the field
value	term which must contain a single properly typed value.

Definition at line 625 of file oprs_protobuf.cpp.

◆ oprs_pb_broadcast()

void oprs_protobuf::OpenPRSProtobuf::oprs_pb_broadcast	(	long int	peer_id,
		void *	msgptr
	)

Broadcast a message through a peer.

Parameters

peer_id	ID broadcast peer to send through
msgptr	message to send

Definition at line 848 of file oprs_protobuf.cpp.

◆ oprs_pb_client_connect()

Term * oprs_protobuf::OpenPRSProtobuf::oprs_pb_client_connect	(	std::string	host,
		int	port
	)

Connect as a client to the given server.

Note that this will perform an asynchronous connect. A (protobuf-client-connected) or (protobuf-client-disconnected) fact is asserted during (pb-process) in the case of success or failure.

Parameters

host	host to connect to
port	TCP port to connect to

Returns: Term with a long long of the client ID

Definition at line 770 of file oprs_protobuf.cpp.

References protobuf_comm::ProtobufStreamClient::async_connect(), protobuf_comm::ProtobufStreamClient::signal_connected(), protobuf_comm::ProtobufStreamClient::signal_disconnected(), protobuf_comm::ProtobufStreamClient::signal_receive_failed(), and protobuf_comm::ProtobufStreamClient::signal_received().

◆ oprs_pb_destroy()

Term * oprs_protobuf::OpenPRSProtobuf::oprs_pb_destroy ( void * msgptr )

Destroy given message (reference).

This will decrement the reference count to the message and delete it. The message itself is deleted if the reference counter reaches zero.

Parameters

msgptr message (reference) to delete, any access to this message afterwards is illegal.

Returns: T

Definition at line 282 of file oprs_protobuf.cpp.

◆ oprs_pb_disable_server()

void oprs_protobuf::OpenPRSProtobuf::oprs_pb_disable_server ( )

Disable protobuf stream server.

Definition at line 114 of file oprs_protobuf.cpp.

◆ oprs_pb_disconnect()

void oprs_protobuf::OpenPRSProtobuf::oprs_pb_disconnect ( long int client_id )

Disconnect a given client.

Parameters

client_id ID of client to disconnect, can be a server client ID or a client ID

Definition at line 875 of file oprs_protobuf.cpp.

References protobuf_comm::ProtobufStreamServer::disconnect().

◆ oprs_pb_enable_server()

void oprs_protobuf::OpenPRSProtobuf::oprs_pb_enable_server ( int port )

Enable protobuf stream server.

Parameters

port	TCP port to listen on for connections

Definition at line 94 of file oprs_protobuf.cpp.

References protobuf_comm::ProtobufStreamServer::signal_connected(), protobuf_comm::ProtobufStreamServer::signal_disconnected(), protobuf_comm::ProtobufStreamServer::signal_receive_failed(), and protobuf_comm::ProtobufStreamServer::signal_received().

◆ oprs_pb_events_pending()

bool oprs_protobuf::OpenPRSProtobuf::oprs_pb_events_pending ( )

Check if there are pending events.

Returns: true if there are pending events, false otherwise

Definition at line 1041 of file oprs_protobuf.cpp.

References fawkes::LockQueue< Type >::mutex(), and fawkes::LockQueue< Type >::push_locked().

◆ oprs_pb_field_is_list()

bool oprs_protobuf::OpenPRSProtobuf::oprs_pb_field_is_list	(	void *	msgptr,
		std::string	field_name
	)

Check if a given field is a list (repeated field).

Parameters

msgptr	message
field_name	name of the field

Returns: true if the field is a list, false otherwise

Definition at line 988 of file oprs_protobuf.cpp.

◆ oprs_pb_field_label()

Term * oprs_protobuf::OpenPRSProtobuf::oprs_pb_field_label	(	void *	msgptr,
		std::string	field_name
	)

Get a fields label.

Parameters

msgptr	message for which to get the field type
field_name	name of the field

Returns: Term with Symbol, one of INVALID-MESSAGE, DOES-NOT-EXIST, OPTIONAL, REPEATED, UNKNOWN

Definition at line 389 of file oprs_protobuf.cpp.

◆ oprs_pb_field_list()

Term * oprs_protobuf::OpenPRSProtobuf::oprs_pb_field_list	(	void *	msgptr,
		std::string	field_name
	)

Get list of values of a given message field.

Parameters

msgptr	message
field_name	field to retrieve

Returns: term which contains a Lisp list with properly typed values, or a symbol in case of an error

Definition at line 904 of file oprs_protobuf.cpp.

References oprs_pb_field_value().

◆ oprs_pb_field_names()

Term * oprs_protobuf::OpenPRSProtobuf::oprs_pb_field_names ( void * msgptr )

Get field names of message.

Parameters

msgptr user pointer to message

Returns: term containing lisp list of field names

Definition at line 298 of file oprs_protobuf.cpp.

◆ oprs_pb_field_type()

Term * oprs_protobuf::OpenPRSProtobuf::oprs_pb_field_type	(	void *	msgptr,
		std::string	field_name
	)

Get type if a specific field.

Parameters

msgptr	message for which to get the field type
field_name	name of the field

Returns: term with a symbol for the type

Definition at line 322 of file oprs_protobuf.cpp.

◆ oprs_pb_field_value()

Term * oprs_protobuf::OpenPRSProtobuf::oprs_pb_field_value	(	void *	msgptr,
		std::string	field_name
	)

Get properly typed field value.

Parameters

msgptr	message for which to get the field type
field_name	name of the field

Returns: Term with value of proper type

Definition at line 412 of file oprs_protobuf.cpp.

Referenced by oprs_pb_field_list().

◆ oprs_pb_has_field()

bool oprs_protobuf::OpenPRSProtobuf::oprs_pb_has_field	(	void *	msgptr,
		std::string	field_name
	)

Check if message has a specific field.

This is relevant in particular for optional fields.

Parameters

msgptr	message
field_name	name of the field

Returns: true if the field is present, false otherwise

Definition at line 363 of file oprs_protobuf.cpp.

◆ oprs_pb_peer_create()

Term * oprs_protobuf::OpenPRSProtobuf::oprs_pb_peer_create	(	std::string	address,
		int	port
	)

Enable protobuf peer.

Parameters

address	IP address to send messages to
port	UDP port to send and receive messages

Returns: peer identifier

Definition at line 180 of file oprs_protobuf.cpp.

References oprs_pb_peer_create_local_crypto().

◆ oprs_pb_peer_create_crypto()

Term * oprs_protobuf::OpenPRSProtobuf::oprs_pb_peer_create_crypto	(	std::string	address,
		int	port,
		std::string	crypto_key = `""`,
		std::string	cipher = `""`
	)

Enable protobuf peer.

Parameters

address	IP address to send messages to
port	UDP port to send and receive messages
crypto_key	encryption key
cipher	cipher suite, see BufferEncryptor for supported types

Returns: peer identifier

Definition at line 168 of file oprs_protobuf.cpp.

References oprs_pb_peer_create_local_crypto().

◆ oprs_pb_peer_create_local()

Term * oprs_protobuf::OpenPRSProtobuf::oprs_pb_peer_create_local	(	std::string	address,
		int	send_port,
		int	recv_port
	)

Enable protobuf peer.

Parameters

address	IP address to send messages to
send_port	UDP port to send messages to
recv_port	UDP port to receive messages on, 0 to use the same as the `send_port`

Returns: peer identifier

Definition at line 192 of file oprs_protobuf.cpp.

References oprs_pb_peer_create_local_crypto().

◆ oprs_pb_peer_create_local_crypto()

Term * oprs_protobuf::OpenPRSProtobuf::oprs_pb_peer_create_local_crypto	(	std::string	address,
		int	send_port,
		int	recv_port,
		std::string	crypto_key = `""`,
		std::string	cipher = `""`
	)

Enable protobuf peer.

Parameters

address	IP address to send messages to
send_port	UDP port to send messages to
recv_port	UDP port to receive messages on, 0 to use the same as the `send_port`
crypto_key	encryption key
cipher	cipher suite, see BufferEncryptor for supported types

Returns: peer identifier

Definition at line 130 of file oprs_protobuf.cpp.

References protobuf_comm::ProtobufBroadcastPeer::signal_received(), protobuf_comm::ProtobufBroadcastPeer::signal_recv_error(), and protobuf_comm::ProtobufBroadcastPeer::signal_send_error().

Referenced by oprs_pb_peer_create(), oprs_pb_peer_create_crypto(), and oprs_pb_peer_create_local().

◆ oprs_pb_peer_destroy()

void oprs_protobuf::OpenPRSProtobuf::oprs_pb_peer_destroy ( long int peer_id )

Disable peer.

Parameters

peer_id ID of the peer to destroy

Definition at line 203 of file oprs_protobuf.cpp.

◆ oprs_pb_peer_setup_crypto()

void oprs_protobuf::OpenPRSProtobuf::oprs_pb_peer_setup_crypto	(	long int	peer_id,
		std::string	crypto_key,
		std::string	cipher
	)

Setup crypto for peer.

Parameters

peer_id	ID of the peer to destroy
crypto_key	encryption key
cipher	cipher suite, see BufferEncryptor for supported types

Definition at line 218 of file oprs_protobuf.cpp.

◆ oprs_pb_process()

void oprs_protobuf::OpenPRSProtobuf::oprs_pb_process ( )

Process all pending events.

This will process events and assert appropriate facts.

Definition at line 1007 of file oprs_protobuf.cpp.

References fawkes::LockQueue< Type >::mutex().

◆ oprs_pb_ref()

Term * oprs_protobuf::OpenPRSProtobuf::oprs_pb_ref ( void * msgptr )

Create new reference to message.

Parameters

msgptr message to create reference for

Returns: new message reference pointing to the very same message as msgptr

Definition at line 264 of file oprs_protobuf.cpp.

◆ oprs_pb_register_type()

bool oprs_protobuf::OpenPRSProtobuf::oprs_pb_register_type ( std::string full_name )

Register a new message type.

Parameters

full_name full name of type to register

Returns: true if the type was successfully registered, false otherwise

Definition at line 232 of file oprs_protobuf.cpp.

References protobuf_comm::MessageRegister::add_message_type().

◆ oprs_pb_send()

void oprs_protobuf::OpenPRSProtobuf::oprs_pb_send	(	long int	client_id,
		void *	msgptr
	)

Send message to a specific client.

Parameters

client_id	ID of the client, this can be a server client ID, a client ID, or a peer ID (message will then be broadcasted).
msgptr	message to send

Definition at line 804 of file oprs_protobuf.cpp.

References protobuf_comm::ProtobufStreamServer::send().

◆ oprs_pb_set_field()

void oprs_protobuf::OpenPRSProtobuf::oprs_pb_set_field	(	void *	msgptr,
		std::string	field_name,
		Term *	value
	)

Set a field.

Parameters

msgptr	message for which to get the field type
field_name	name of the field
value	term which must contain a single properly typed value.

Definition at line 467 of file oprs_protobuf.cpp.

◆ peers()

const std::map<long int, protobuf_comm::ProtobufBroadcastPeer *>& oprs_protobuf::OpenPRSProtobuf::peers ( ) const

inline

Get protobuf_comm peers.

Returns: protobuf_comm peer

Definition at line 74 of file oprs_protobuf.h.

◆ server()

protobuf_comm::ProtobufStreamServer* oprs_protobuf::OpenPRSProtobuf::server ( ) const

inline

Get Protobuf server.

Returns: protobuf server

Definition at line 68 of file oprs_protobuf.h.

◆ signal_client_sent()

boost::signals2::signal<void (std::string, unsigned short, std::shared_ptr<google::protobuf::Message>)>& oprs_protobuf::OpenPRSProtobuf::signal_client_sent ( )

inline

Signal invoked for a message that has been sent to a client.

Returns: signal

Definition at line 94 of file oprs_protobuf.h.

◆ signal_peer_sent()

boost::signals2::signal<void (long int, std::shared_ptr<google::protobuf::Message>)>& oprs_protobuf::OpenPRSProtobuf::signal_peer_sent ( )

inline

Signal invoked for a message that has been sent via broadcast.

Returns: signal

Definition at line 100 of file oprs_protobuf.h.

◆ signal_server_sent()

boost::signals2::signal<void (protobuf_comm::ProtobufStreamServer::ClientID, std::shared_ptr<google::protobuf::Message>)>& oprs_protobuf::OpenPRSProtobuf::signal_server_sent ( )

inline

Signal invoked for a message that has been sent to a server client.

Returns: signal

Definition at line 87 of file oprs_protobuf.h.

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

src/plugins/openprs-agent/oprs_protobuf.h
src/plugins/openprs-agent/oprs_protobuf.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ OpenPRSProtobuf()

◆ ~OpenPRSProtobuf()

Member Function Documentation

◆ message_register()

◆ oprs_create_msg()

◆ oprs_pb_add_list()

◆ oprs_pb_broadcast()

◆ oprs_pb_client_connect()

◆ oprs_pb_destroy()

◆ oprs_pb_disable_server()

◆ oprs_pb_disconnect()

◆ oprs_pb_enable_server()

◆ oprs_pb_events_pending()

◆ oprs_pb_field_is_list()

◆ oprs_pb_field_label()

◆ oprs_pb_field_list()

◆ oprs_pb_field_names()

◆ oprs_pb_field_type()

◆ oprs_pb_field_value()

◆ oprs_pb_has_field()

◆ oprs_pb_peer_create()

◆ oprs_pb_peer_create_crypto()

◆ oprs_pb_peer_create_local()

◆ oprs_pb_peer_create_local_crypto()

◆ oprs_pb_peer_destroy()

◆ oprs_pb_peer_setup_crypto()

◆ oprs_pb_process()

◆ oprs_pb_ref()

◆ oprs_pb_register_type()

◆ oprs_pb_send()

◆ oprs_pb_set_field()

◆ peers()

◆ server()

◆ signal_client_sent()

◆ signal_peer_sent()

◆ signal_server_sent()