vrpn
07.33
Virtual Reality Peripheral Network
|
Allows a user to handle text messages directly, in addition too having the. More...
#include <vrpn_Text.h>
Public Member Functions | |
vrpn_Text_Receiver (const char *name, vrpn_Connection *c=NULL) | |
virtual | ~vrpn_Text_Receiver (void) |
virtual int | register_message_handler (void *userdata, vrpn_TEXTHANDLER handler) |
virtual int | unregister_message_handler (void *userdata, vrpn_TEXTHANDLER 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... | |
![]() | |
vrpn_BaseClass (const char *name, vrpn_Connection *c=NULL) | |
Names the device and assigns or opens connection, calls registration methods. More... | |
virtual | ~vrpn_BaseClass () |
![]() | |
vrpn_BaseClassUnique () | |
virtual | ~vrpn_BaseClassUnique () |
Unregister all of the message handlers that were to be autodeleted. More... | |
vrpn_Connection * | connectionPtr () |
Returns a pointer to the connection this object is using. More... | |
Protected Member Functions | |
virtual int | register_types (void) |
No types to register beyond the text, which is done in BaseClass. More... | |
![]() | |
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... | |
![]() | |
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... | |
Static Protected Member Functions | |
static int VRPN_CALLBACK | handle_message (void *userdata, vrpn_HANDLERPARAM p) |
![]() | |
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_TEXTCB > | d_callback_list |
![]() | |
vrpn_Connection * | d_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 | |
![]() | |
bool | shutup |
vrpn_MESSAGEHANDLER | handler |
vrpn_int32 | sender |
vrpn_int32 | type |
void * | userdata |
Allows a user to handle text messages directly, in addition too having the.
Definition at line 68 of file vrpn_Text.h.
vrpn_Text_Receiver::vrpn_Text_Receiver | ( | const char * | name, |
vrpn_Connection * | c = NULL |
||
) |
Definition at line 21 of file vrpn_Text.C.
References vrpn_BaseClassUnique::d_connection, vrpn_BaseClassUnique::d_sender_id, vrpn_BaseClassUnique::d_text_message_id, handle_message(), vrpn_BaseClass::init(), and vrpn_BaseClassUnique::register_autodeleted_handler().
|
virtual |
Definition at line 31 of file vrpn_Text.C.
|
staticprotected |
Definition at line 33 of file vrpn_Text.C.
References vrpn_HANDLERPARAM::buffer, vrpn_Callback_List< CALLBACK_STRUCT >::call_handlers(), d_callback_list, vrpn_BaseClassUnique::decode_text_message_from_buffer(), vrpn_HANDLERPARAM::msg_time, and vrpn_BaseClassUnique::userdata.
Referenced by vrpn_Text_Receiver().
|
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_Sound_Client.
Definition at line 84 of file vrpn_Text.h.
References vrpn_BaseClassUnique::client_mainloop().
|
inlinevirtual |
Definition at line 72 of file vrpn_Text.h.
Referenced by vrpn_Sound_Client::vrpn_Sound_Client().
|
inlineprotectedvirtual |
No types to register beyond the text, which is done in BaseClass.
Implements vrpn_BaseClass.
Definition at line 98 of file vrpn_Text.h.
|
inlinevirtual |
Definition at line 78 of file vrpn_Text.h.
|
protected |
Definition at line 95 of file vrpn_Text.h.
Referenced by handle_message().