vrpn 07.35
Virtual Reality Peripheral Network
Loading...
Searching...
No Matches
vrpn_Auxiliary_Logger_Server Class Referenceabstract

#include <vrpn_Auxiliary_Logger.h>

Inheritance diagram for vrpn_Auxiliary_Logger_Server:
Collaboration diagram for vrpn_Auxiliary_Logger_Server:

Public Member Functions

 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 Member Functions

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

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.
 

Protected Attributes

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
 

Detailed Description

Definition at line 65 of file vrpn_Auxiliary_Logger.h.

Constructor & Destructor Documentation

◆ vrpn_Auxiliary_Logger_Server()

Member Function Documentation

◆ handle_dropped_last_connection()

void vrpn_Auxiliary_Logger_Server::handle_dropped_last_connection ( void  )
protectedvirtual

Reimplemented in vrpn_Imager_Stream_Buffer.

Definition at line 246 of file vrpn_Auxiliary_Logger.C.

References handle_request_logging().

Referenced by static_handle_dropped_last_connection().

Here is the call graph for this function:

◆ handle_request_logging()

virtual void vrpn_Auxiliary_Logger_Server::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 
)
protectedpure virtual

◆ handle_request_logging_status()

virtual void vrpn_Auxiliary_Logger_Server::handle_request_logging_status ( )
protectedpure virtual

◆ mainloop()

virtual void vrpn_Auxiliary_Logger_Server::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().

Implements vrpn_BaseClass.

Reimplemented in vrpn_Auxiliary_Logger_Server_Generic, and vrpn_Imager_Stream_Buffer.

Definition at line 70 of file vrpn_Auxiliary_Logger.h.

References vrpn_BaseClassUnique::server_mainloop().

Referenced by vrpn_Auxiliary_Logger_Server_Generic::mainloop().

Here is the call graph for this function:

◆ send_report_logging()

bool vrpn_Auxiliary_Logger_Server::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 
)
inlineprotected

◆ static_handle_dropped_last_connection()

int vrpn_Auxiliary_Logger_Server::static_handle_dropped_last_connection ( void *  userdata,
vrpn_HANDLERPARAM  p 
)
staticprotected

Definition at line 253 of file vrpn_Auxiliary_Logger.C.

References handle_dropped_last_connection(), and vrpn_BaseClassUnique::userdata.

Referenced by vrpn_Auxiliary_Logger_Server().

Here is the call graph for this function:

◆ static_handle_request_logging()

int vrpn_Auxiliary_Logger_Server::static_handle_request_logging ( void *  userdata,
vrpn_HANDLERPARAM  p 
)
staticprotected

◆ static_handle_request_logging_status()

int vrpn_Auxiliary_Logger_Server::static_handle_request_logging_status ( void *  userdata,
vrpn_HANDLERPARAM  p 
)
staticprotected

Definition at line 263 of file vrpn_Auxiliary_Logger.C.

References handle_request_logging_status(), and vrpn_BaseClassUnique::userdata.

Referenced by vrpn_Auxiliary_Logger_Server().

Here is the call graph for this function:

Member Data Documentation

◆ dropped_last_connection_m_id

vrpn_int32 vrpn_Auxiliary_Logger_Server::dropped_last_connection_m_id
protected

Definition at line 111 of file vrpn_Auxiliary_Logger.h.

Referenced by vrpn_Auxiliary_Logger_Server().


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