vrpn  07.33
Virtual Reality Peripheral Network
vrpn_Auxiliary_Logger_Remote Class Reference

#include <vrpn_Auxiliary_Logger.h>

Inheritance diagram for vrpn_Auxiliary_Logger_Remote:
Collaboration diagram for vrpn_Auxiliary_Logger_Remote:

Public Member Functions

 vrpn_Auxiliary_Logger_Remote (const char *name, vrpn_Connection *c=NULL)
 
bool send_logging_request (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 send_logging_status_request ()
 
virtual int register_report_handler (void *userdata, vrpn_AUXLOGGERREPORTHANDLER handler)
 
virtual int unregister_report_handler (void *userdata, vrpn_AUXLOGGERREPORTHANDLER handler)
 
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(). More...
 
- 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. More...
 
virtual ~vrpn_BaseClass ()
 
- Public Member Functions inherited from vrpn_BaseClassUnique
 vrpn_BaseClassUnique ()
 
virtual ~vrpn_BaseClassUnique ()
 Unregister all of the message handlers that were to be autodeleted. More...
 
vrpn_ConnectionconnectionPtr ()
 Returns a pointer to the connection this object is using. More...
 

Static Protected Member Functions

static int VRPN_CALLBACK handle_report_message (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. More...
 
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. More...
 

Protected Attributes

vrpn_Callback_List< vrpn_AUXLOGGERCB > d_callback_list
 
- 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. More...
 
char * d_servicename
 Name of this device, not including the connection part. More...
 
vrpn_int32 d_sender_id
 Sender ID registered with the connection. More...
 
vrpn_int32 d_text_message_id
 ID for text messages. More...
 
vrpn_int32 d_ping_message_id
 Ask the server if they are there. More...
 
vrpn_int32 d_pong_message_id
 Server telling that it is there. More...
 

Additional Inherited Members

- Public Attributes inherited from vrpn_BaseClassUnique
bool shutup
 
vrpn_MESSAGEHANDLER handler
 
vrpn_int32 sender
 
vrpn_int32 type
 
void * userdata
 
- 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. More...
 
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. More...
 
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. More...
 
- 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. More...
 
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. More...
 
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. More...
 
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() More...
 
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() More...
 

Detailed Description

Definition at line 192 of file vrpn_Auxiliary_Logger.h.

Constructor & Destructor Documentation

◆ vrpn_Auxiliary_Logger_Remote()

vrpn_Auxiliary_Logger_Remote::vrpn_Auxiliary_Logger_Remote ( const char *  name,
vrpn_Connection c = NULL 
)

Member Function Documentation

◆ handle_report_message()

int VRPN_CALLBACK vrpn_Auxiliary_Logger_Remote::handle_report_message ( void *  userdata,
vrpn_HANDLERPARAM  p 
)
staticprotected

◆ mainloop()

void vrpn_Auxiliary_Logger_Remote::mainloop ( void  )
virtual

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().

Implements vrpn_BaseClass.

Definition at line 439 of file vrpn_Auxiliary_Logger.C.

References vrpn_BaseClassUnique::client_mainloop(), vrpn_BaseClassUnique::d_connection, and vrpn_Connection::mainloop().

Here is the call graph for this function:

◆ register_report_handler()

virtual int vrpn_Auxiliary_Logger_Remote::register_report_handler ( void *  userdata,
vrpn_AUXLOGGERREPORTHANDLER  handler 
)
inlinevirtual

Definition at line 230 of file vrpn_Auxiliary_Logger.h.

◆ send_logging_request()

bool vrpn_Auxiliary_Logger_Remote::send_logging_request ( const char *  local_in_logfile_name,
const char *  local_out_logfile_name = "",
const char *  remote_in_logfile_name = "",
const char *  remote_out_logfile_name = "" 
)
inline

Definition at line 207 of file vrpn_Auxiliary_Logger.h.

References vrpn_Auxiliary_Logger::pack_log_message_of_type().

Here is the call graph for this function:

◆ send_logging_status_request()

bool vrpn_Auxiliary_Logger_Remote::send_logging_status_request ( )
inline

Definition at line 220 of file vrpn_Auxiliary_Logger.h.

References vrpn_Auxiliary_Logger::pack_log_message_of_type().

Here is the call graph for this function:

◆ unregister_report_handler()

virtual int vrpn_Auxiliary_Logger_Remote::unregister_report_handler ( void *  userdata,
vrpn_AUXLOGGERREPORTHANDLER  handler 
)
inlinevirtual

Definition at line 235 of file vrpn_Auxiliary_Logger.h.

Member Data Documentation

◆ d_callback_list

vrpn_Callback_List<vrpn_AUXLOGGERCB> vrpn_Auxiliary_Logger_Remote::d_callback_list
protected

Definition at line 247 of file vrpn_Auxiliary_Logger.h.

Referenced by handle_report_message().


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