Allows a user to send text messages from a device (usually,. More...
#include <vrpn_Text.h>
Public Member Functions | |
vrpn_Text_Sender (const char *name, vrpn_Connection *c=NULL) | |
void | mainloop (void) |
Mainloop the connection to send the message. | |
int | send_message (const char *msg, vrpn_TEXT_SEVERITY type=vrpn_TEXT_NORMAL, vrpn_uint32 level=0, const struct timeval time=vrpn_TEXT_NOW) |
Send a text message. | |
![]() | |
vrpn_BaseClass (const char *name, vrpn_Connection *c=NULL) | |
Names the device and assigns or opens connection, calls registration methods. | |
virtual | ~vrpn_BaseClass () |
![]() | |
vrpn_BaseClassUnique () | |
virtual | ~vrpn_BaseClassUnique () |
Unregister all of the message handlers that were to be autodeleted. | |
vrpn_Connection * | connectionPtr () |
Returns a pointer to the connection this object is using. | |
Protected Member Functions | |
virtual int | register_types (void) |
No types to register beyond the text, which is done in 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. | |
![]() | |
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() | |
Additional Inherited Members | |
![]() | |
bool | shutup |
![]() | |
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. | |
![]() | |
vrpn_Connection * | d_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. | |
Allows a user to send text messages from a device (usually,.
Definition at line 40 of file vrpn_Text.h.
|
inline |
Definition at line 42 of file vrpn_Text.h.
References vrpn_BaseClass::init(), and vrpn_BaseClass::vrpn_BaseClass().
Referenced by vrpn_Sound_Server::vrpn_Sound_Server().
|
inlinevirtual |
Mainloop the connection to send the message.
Implements vrpn_BaseClass.
Definition at line 49 of file vrpn_Text.h.
References vrpn_BaseClassUnique::d_connection, and vrpn_BaseClassUnique::server_mainloop().
|
inlineprotectedvirtual |
No types to register beyond the text, which is done in BaseClass.
Implements vrpn_BaseClass.
Definition at line 63 of file vrpn_Text.h.
int vrpn_Text_Sender::send_message | ( | const char * | msg, |
vrpn_TEXT_SEVERITY | type = vrpn_TEXT_NORMAL, | ||
vrpn_uint32 | level = 0, | ||
const struct timeval | time = vrpn_TEXT_NOW ) |
Send a text message.
Definition at line 3 of file vrpn_Text.C.
References vrpn_BaseClassUnique::send_text_message(), vrpn_BaseClassUnique::type, vrpn_gettimeofday, and vrpn_TEXT_NOW.