vrpn 07.35
Virtual Reality Peripheral Network
Loading...
Searching...
No Matches
vrpn_Auxiliary_Logger_Server_Generic Class Reference

#include <vrpn_Auxiliary_Logger.h>

Inheritance diagram for vrpn_Auxiliary_Logger_Server_Generic:
Collaboration diagram for vrpn_Auxiliary_Logger_Server_Generic:

Public Member Functions

 vrpn_Auxiliary_Logger_Server_Generic (const char *logger_name, const char *connection_to_log, vrpn_Connection *c=NULL)
 
 ~vrpn_Auxiliary_Logger_Server_Generic ()
 
virtual void handle_request_logging (const char *local_in_logfile_name, const char *local_out_logfile_name, const char *remote_in_logfile_name, const char *remote_out_logfile_name)
 
virtual void handle_request_logging_status ()
 
virtual void mainloop (void)
 Called once through each main loop iteration to handle updates. Remote object mainloop() should call client_mainloop() and then call d_connection->mainloop(). Server object mainloop() should service the device and then call server_mainloop(), but should not normally call d_connection->mainloop().
 
- Public Member Functions inherited from vrpn_Auxiliary_Logger_Server
 vrpn_Auxiliary_Logger_Server (const char *name, vrpn_Connection *c)
 
virtual void mainloop (void)
 Called once through each main loop iteration to handle updates. Remote object mainloop() should call client_mainloop() and then call d_connection->mainloop(). Server object mainloop() should service the device and then call server_mainloop(), but should not normally call d_connection->mainloop().
 
- Public Member Functions inherited from vrpn_Auxiliary_Logger
 vrpn_Auxiliary_Logger (const char *name, vrpn_Connection *c)
 
- Public Member Functions inherited from vrpn_BaseClass
 vrpn_BaseClass (const char *name, vrpn_Connection *c=NULL)
 Names the device and assigns or opens connection, calls registration methods.
 
virtual ~vrpn_BaseClass ()
 
virtual void mainloop ()=0
 Called once through each main loop iteration to handle updates. Remote object mainloop() should call client_mainloop() and then call d_connection->mainloop(). Server object mainloop() should service the device and then call server_mainloop(), but should not normally call d_connection->mainloop().
 
- Public Member Functions inherited from vrpn_BaseClassUnique
 vrpn_BaseClassUnique ()
 
virtual ~vrpn_BaseClassUnique ()
 Unregister all of the message handlers that were to be autodeleted.
 
vrpn_ConnectionconnectionPtr ()
 Returns a pointer to the connection this object is using.
 

Protected Attributes

char * d_connection_name
 
vrpn_Connectiond_logging_connection
 
- Protected Attributes inherited from vrpn_Auxiliary_Logger_Server
vrpn_int32 dropped_last_connection_m_id
 
- Protected Attributes inherited from vrpn_Auxiliary_Logger
vrpn_int32 request_logging_m_id
 
vrpn_int32 report_logging_m_id
 
vrpn_int32 request_logging_status_m_id
 
- Protected Attributes inherited from vrpn_BaseClassUnique
vrpn_Connectiond_connection
 Connection that this object talks to.
 
char * d_servicename
 Name of this device, not including the connection part.
 
vrpn_int32 d_sender_id
 Sender ID registered with the connection.
 
vrpn_int32 d_text_message_id
 ID for text messages.
 
vrpn_int32 d_ping_message_id
 Ask the server if they are there.
 
vrpn_int32 d_pong_message_id
 Server telling that it is there.
 

Additional Inherited Members

- Public Attributes inherited from vrpn_BaseClassUnique
bool shutup
 
- Protected Member Functions inherited from vrpn_Auxiliary_Logger_Server
virtual void handle_request_logging (const char *local_in_logfile_name, const char *local_out_logfile_name, const char *remote_in_logfile_name, const char *remote_out_logfile_name)=0
 
bool send_report_logging (const char *local_in_logfile_name, const char *local_out_logfile_name, const char *remote_in_logfile_name, const char *remote_out_logfile_name)
 
virtual void handle_dropped_last_connection (void)
 
virtual void handle_request_logging_status ()=0
 
- Protected Member Functions inherited from vrpn_Auxiliary_Logger
virtual int register_types (void)
 Register the types of messages this device sends/receives. Return 0 on success, -1 on fail.
 
bool pack_log_message_of_type (vrpn_int32 type, const char *local_in_logfile_name, const char *local_out_logfile_name, const char *remote_in_logfile_name, const char *remote_out_logfile_name)
 
bool unpack_log_message_from_buffer (const char *buf, vrpn_int32 buflen, char **local_in_logfile_name, char **local_out_logfile_name, char **remote_in_logfile_name, char **remote_out_logfile_name)
 
- Protected Member Functions inherited from vrpn_BaseClass
virtual int init (void)
 Initialize things that the constructor can't. Returns 0 on success, -1 on failure.
 
virtual int register_senders (void)
 Register the sender for this device (by default, the name of the device). Return 0 on success, -1 on fail.
 
virtual int register_types (void)=0
 Register the types of messages this device sends/receives. Return 0 on success, -1 on fail.
 
- Protected Member Functions inherited from vrpn_BaseClassUnique
int register_autodeleted_handler (vrpn_int32 type, vrpn_MESSAGEHANDLER handler, void *userdata, vrpn_int32 sender=vrpn_ANY_SENDER)
 Registers a handler with the connection, and remembers to delete at destruction.
 
int send_text_message (const char *msg, struct timeval timestamp, vrpn_TEXT_SEVERITY type=vrpn_TEXT_NORMAL, vrpn_uint32 level=0)
 Sends a NULL-terminated text message from the device d_sender_id.
 
SendTextMessageBoundCall send_text_message (vrpn_TEXT_SEVERITY type=vrpn_TEXT_NORMAL)
 Returns an object you can stream into to send a text message from the device like send_text_message(vrpn_TEXT_WARNING) << "Value of i is: " << i; This use requires including vrpn_SendTextMessageStreamProxy.h.
 
void server_mainloop (void)
 Handles functions that all servers should provide in their mainloop() (ping/pong, for example) Should be called by all servers in their mainloop()
 
void client_mainloop (void)
 Handles functions that all clients should provide in their mainloop() (warning of no server, for example) Should be called by all clients in their mainloop()
 
- Static Protected Member Functions inherited from vrpn_Auxiliary_Logger_Server
static int VRPN_CALLBACK static_handle_dropped_last_connection (void *userdata, vrpn_HANDLERPARAM p)
 
static int VRPN_CALLBACK static_handle_request_logging (void *userdata, vrpn_HANDLERPARAM p)
 
static int VRPN_CALLBACK static_handle_request_logging_status (void *userdata, vrpn_HANDLERPARAM p)
 
- Static Protected Member Functions inherited from vrpn_BaseClassUnique
static int encode_text_message_to_buffer (char *buf, vrpn_TEXT_SEVERITY severity, vrpn_uint32 level, const char *msg)
 Encodes the body of the text message into a buffer, preparing for sending.
 
static int decode_text_message_from_buffer (char *msg, vrpn_TEXT_SEVERITY *severity, vrpn_uint32 *level, const char *buf)
 Decodes the body of the text message from a buffer from the connection.
 

Detailed Description

Definition at line 133 of file vrpn_Auxiliary_Logger.h.

Constructor & Destructor Documentation

◆ vrpn_Auxiliary_Logger_Server_Generic()

vrpn_Auxiliary_Logger_Server_Generic::vrpn_Auxiliary_Logger_Server_Generic ( const char *  logger_name,
const char *  connection_to_log,
vrpn_Connection c = NULL 
)

◆ ~vrpn_Auxiliary_Logger_Server_Generic()

vrpn_Auxiliary_Logger_Server_Generic::~vrpn_Auxiliary_Logger_Server_Generic ( )

Definition at line 350 of file vrpn_Auxiliary_Logger.C.

References d_connection_name, and d_logging_connection.

Member Function Documentation

◆ handle_request_logging()

void vrpn_Auxiliary_Logger_Server_Generic::handle_request_logging ( const char *  local_in_logfile_name,
const char *  local_out_logfile_name,
const char *  remote_in_logfile_name,
const char *  remote_out_logfile_name 
)
virtual

◆ handle_request_logging_status()

void vrpn_Auxiliary_Logger_Server_Generic::handle_request_logging_status ( )
virtual

Implements vrpn_Auxiliary_Logger_Server.

Definition at line 431 of file vrpn_Auxiliary_Logger.C.

References d_logging_connection, vrpn_Connection::get_log_names(), and vrpn_Auxiliary_Logger_Server::send_report_logging().

Here is the call graph for this function:

◆ mainloop()

virtual void vrpn_Auxiliary_Logger_Server_Generic::mainloop ( void  )
inlinevirtual

Called once through each main loop iteration to handle updates. Remote object mainloop() should call client_mainloop() and then call d_connection->mainloop(). Server object mainloop() should service the device and then call server_mainloop(), but should not normally call d_connection->mainloop().

Reimplemented from vrpn_Auxiliary_Logger_Server.

Definition at line 158 of file vrpn_Auxiliary_Logger.h.

References vrpn_Auxiliary_Logger_Server::mainloop().

Here is the call graph for this function:

Member Data Documentation

◆ d_connection_name

char* vrpn_Auxiliary_Logger_Server_Generic::d_connection_name
protected

◆ d_logging_connection

vrpn_Connection* vrpn_Auxiliary_Logger_Server_Generic::d_logging_connection
protected

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