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

Accepts commands over a connection to control a local vrpn_RedundantTransmission's default parameters. More...

#include <vrpn_RedundantTransmission.h>

Inheritance diagram for vrpn_RedundantController:
Collaboration diagram for vrpn_RedundantController:

Public Member Functions

 vrpn_RedundantController (vrpn_RedundantTransmission *, vrpn_Connection *)
 
 ~vrpn_RedundantController (void)
 
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_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 int register_types (void)
 Register the types of messages this device sends/receives. Return 0 on success, -1 on fail.
 
- 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 handle_set (void *, vrpn_HANDLERPARAM)
 
static int VRPN_CALLBACK handle_enable (void *, vrpn_HANDLERPARAM)
 
- 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_RedundantController_Protocol d_protocol
 
vrpn_RedundantTransmissiond_object
 
- 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
 
vrpn_MESSAGEHANDLER handler
 
vrpn_int32 sender
 
vrpn_int32 type
 
void * userdata
 

Detailed Description

Accepts commands over a connection to control a local vrpn_RedundantTransmission's default parameters.

Definition at line 96 of file vrpn_RedundantTransmission.h.

Constructor & Destructor Documentation

◆ vrpn_RedundantController()

◆ ~vrpn_RedundantController()

vrpn_RedundantController::~vrpn_RedundantController ( void  )

Definition at line 296 of file vrpn_RedundantTransmission.C.

Member Function Documentation

◆ handle_enable()

int vrpn_RedundantController::handle_enable ( void *  ud,
vrpn_HANDLERPARAM  p 
)
staticprotected

◆ handle_set()

int vrpn_RedundantController::handle_set ( void *  ud,
vrpn_HANDLERPARAM  p 
)
staticprotected

◆ mainloop()

void vrpn_RedundantController::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 298 of file vrpn_RedundantTransmission.C.

References vrpn_BaseClassUnique::server_mainloop().

Here is the call graph for this function:

◆ register_types()

int vrpn_RedundantController::register_types ( void  )
protectedvirtual

Register the types of messages this device sends/receives. Return 0 on success, -1 on fail.

Implements vrpn_BaseClass.

Definition at line 305 of file vrpn_RedundantTransmission.C.

References vrpn_BaseClassUnique::d_connection, d_protocol, and vrpn_RedundantController_Protocol::register_types().

Here is the call graph for this function:

Member Data Documentation

◆ d_object

vrpn_RedundantTransmission* vrpn_RedundantController::d_object
protected

Definition at line 113 of file vrpn_RedundantTransmission.h.

Referenced by handle_enable(), and handle_set().

◆ d_protocol

vrpn_RedundantController_Protocol vrpn_RedundantController::d_protocol
protected

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