vrpn
07.33
Virtual Reality Peripheral Network
|
Constructor for a Loopback connection that will basically just pass messages between objects that are connected to it. It offers no external connections, via IP or any other mechanism. It is useful if you want to make the client and server in the same connection and you don't need to have anything else connect. More...
#include <vrpn_Connection.h>
Public Member Functions | |
virtual | ~vrpn_Connection_Loopback (void) |
virtual int | mainloop (const struct timeval *timeout=NULL) |
Call each time through program main loop to handle receiving any incoming messages and sending any packed messages. Returns -1 on error, 0 otherwise. Optional argument is TOTAL time to block on select() calls; there may be multiple calls to select() per call to mainloop(), and this timeout will be divided evenly between them. More... | |
virtual vrpn_bool | doing_okay (void) const |
Returns vrpn_true if the connection is okay, vrpn_false if not. More... | |
virtual vrpn_bool | connected (void) const |
Returns vrpn_true if the connection has been established, vrpn_false if not (For a networkless connection, this is equivalent to doing_okay()). More... | |
![]() | |
virtual | ~vrpn_Connection (void) |
void | get_log_names (char **local_in_logname, char **local_out_logname, char **remote_in_logname, char **remote_out_logname) |
This function returns the logfile names of this connection in the parameters. It will allocate memory for the name of each log file in use. If no logging of a particular type is happening, then *(X_Y_logname) will be set to NULL. IMPORTANT: code calling this function is responsible for freeing the memory allocated for these strings. More... | |
virtual vrpn_int32 | register_sender (const char *name) |
Get a token to use for the string name of the sender or type. Remember to check for -1 meaning failure. More... | |
virtual vrpn_int32 | register_message_type (const char *name) |
virtual int | register_handler (vrpn_int32 type, vrpn_MESSAGEHANDLER handler, void *userdata, vrpn_int32 sender=vrpn_ANY_SENDER) |
Set up (or remove) a handler for a message of a given type. Optionally, specify which sender to handle messages from. Handlers will be called during mainloop(). Your handler should return 0 or a communication error is assumed and the connection will be shut down. More... | |
virtual int | unregister_handler (vrpn_int32 type, vrpn_MESSAGEHANDLER handler, void *userdata, vrpn_int32 sender=vrpn_ANY_SENDER) |
virtual int | pack_message (vrpn_uint32 len, struct timeval time, vrpn_int32 type, vrpn_int32 sender, const char *buffer, vrpn_uint32 class_of_service) |
Pack a message that will be sent the next time mainloop() is called. Turn off the RELIABLE flag if you want low-latency (UDP) send. More... | |
virtual int | time_since_connection_open (struct timeval *elapsed_time) |
Returns the time since the connection opened. Some subclasses may redefine time. More... | |
virtual timeval | get_time () |
returns the current time in the connection (since the epoch – UTC time). More... | |
virtual const char * | sender_name (vrpn_int32 sender) |
Returns the name of the specified sender/type, or NULL if the parameter is invalid. Only works for user messages (type >= 0). More... | |
virtual const char * | message_type_name (vrpn_int32 type) |
virtual int | register_log_filter (vrpn_LOGFILTER filter, void *userdata) |
Sets up a filter function for logging. Any user message to be logged is first passed to this function, and will only be logged if the function returns zero (XXX). NOTE: this only affects local logging - remote logging is unfiltered! Only user messages are filtered; all system messages are logged. Returns nonzero on failure. More... | |
virtual int | save_log_so_far () |
Save any messages on any endpoints which have been logged so far. More... | |
virtual vrpn_File_Connection * | get_File_Connection (void) |
vrpn_File_Connection implements this as "return this" so it can be used to detect a File_Connection and get the pointer for it More... | |
void | Jane_stop_this_crazy_thing (vrpn_uint32 stop_looking_after) |
This function should be seldom used. It is here for the case of the vrpn_Imager, whose servers do not follow "The VRPN Way" because they try to jam more data into the network than there is bandwidth to support it. As a result, a client may call mainloop() on the connection and have it never return – there is always more data in the network to read, so we never hand control back to the main program. The reason for the name comes from an old U.S. cartoon called "The Jetsons". In it, George Jetson is running on a treadmill when it goes out of control and starts spinning so fast that he can't even run fast enough to reach the controls and turn it off. He cries out to his wife, "Jane! Stop this crazy thing!" The parameter specifies a trigger: if more than the specified number of messages come in on a given input channel during one mainloop() call, the connection should stop looking for more messages. NOTE: this does not guarantee that only this many messages will be received, only that the connection will stop looking for new ones on a given channel once that many have been received (for example, UDP channels will parse all the rest of the messages in a packet before stopping). A value of 0 turns off the limit, and will cause all incoming messages to be handled before returning. More... | |
vrpn_uint32 | get_Jane_value (void) |
void | addReference () |
Counting references to this connection. More... | |
void | removeReference () |
void | setAutoDeleteStatus (bool setvalue) |
Specify whether this connection should be deleted automatically when it is no longer need (reference count reaches zero). For connections created by the VRPN code (as is done in get_connection_by_name) these should be auto-deleted. Connections created by user code should not be auto-deleted; that is up to the user to decide when finished. By default, the constructor sets this to FALSE. VRPN code (or user code) can set this to TRUE if it wants the connection to be deleted automatically when the last service on it is deleted. More... | |
Protected Member Functions | |
vrpn_Connection_Loopback () | |
Make a client connection. To access this from user code, call vrpn_create_server_connection() with a service name of 'loopback:'. For now, we don't enable logging on a Loopback connection. More... | |
virtual int | send_pending_reports (void) |
send pending report, clear the buffer. More... | |
![]() | |
vrpn_Connection (const char *local_in_logfile_name, const char *local_out_logfile_name, vrpn_Endpoint_IP *(*epa)(vrpn_Connection *, vrpn_int32 *)=allocateEndpoint) | |
Constructor for server connection. This cannot be called directly any more because vrpn_Connection is an abstract base class. Call vrpn_create_server_connection() to make a server of arbitrary type based on a name. More... | |
vrpn_Connection (const char *local_in_logfile_name, const char *local_out_logfile_name, const char *remote_in_logfile_name, const char *remote_out_logfile_name, vrpn_Endpoint_IP *(*epa)(vrpn_Connection *, vrpn_int32 *)=allocateEndpoint) | |
Constructor for client connection. This cannot be called directly because vrpn_Connection is an abstract base class. Call vrpn_get_connection_by_name() to create a client connection. More... | |
virtual void | init (void) |
Base initialization for all constructors. More... | |
int | delete_endpoint (int whichEndpoint) |
Deletes the endpoint and NULLs the entry in the list of open endpoints. More... | |
int | compact_endpoints (void) |
Makes sure the endpoint array is set up cleanly for the next pass through. More... | |
virtual int | pack_sender_description (vrpn_int32 which) |
Send the sender description to ALL endpoints. More... | |
virtual int | pack_type_description (vrpn_int32 which) |
Send the type description to ALL endpoints. More... | |
virtual int | do_callbacks_for (vrpn_int32 type, vrpn_int32 sender, struct timeval time, vrpn_uint32 len, const char *buffer) |
int | message_type_is_registered (const char *) const |
Returns message type ID, or -1 if unregistered. More... | |
int | doSystemCallbacksFor (vrpn_HANDLERPARAM, void *) |
virtual void | updateEndpoints (void) |
This function will be called on the mainloop() iteration after *d_endpointAllocator is called, which lets subclasses do initialization. (They can't do so during allocateEndpoint because it's called during the Connection constructor when their constructors haven't executed yet.) More... | |
Friends | |
VRPN_API vrpn_Connection * | vrpn_create_server_connection (const char *cname, const char *local_in_logfile_name, const char *local_out_logfile_name) |
Create a server connection of arbitrary type (VRPN UDP/TCP, TCP, File, Loopback, MPI). More... | |
Additional Inherited Members | |
![]() | |
vrpn_TypeDispatcher * | d_dispatcher |
Derived classes need access to d_dispatcher in their allocateEndpoint() routine. Several compilers won't give it to them, even if they do inherit publicly. Until we figure that out, d_dispatcher needs to be public. More... | |
![]() | |
static vrpn_Endpoint_IP * | allocateEndpoint (vrpn_Connection *, vrpn_int32 *connectedEC) |
Redefining this and passing it to constructors allows a subclass to use a different subclass of Endpoint. It should do NOTHING but return an endpoint of the appropriate class; it may not access subclass data, since it'll be called from a constructor. More... | |
static int VRPN_CALLBACK | handle_log_message (void *userdata, vrpn_HANDLERPARAM p) |
Routines that handle system messages. More... | |
static int VRPN_CALLBACK | handle_disconnect_message (void *userdata, vrpn_HANDLERPARAM p) |
![]() | |
vrpn_uint32 | d_stop_processing_messages_after |
If this value is greater than zero, the connection should stop looking for new messages on a given endpoint after this many are found. More... | |
int | connectionStatus |
Status of the connection. More... | |
vrpn_Endpoint_IP * | d_endpoints [vrpn_MAX_ENDPOINTS] |
Sockets used to talk to remote Connection(s) and other information needed on a per-connection basis. More... | |
vrpn_int32 | d_numEndpoints |
vrpn_int32 | d_numConnectedEndpoints |
We need to track the number of connected endpoints separately to properly send out got-first-connection/dropped-last-connection messages. This value is managed by the Endpoints, but we need exactly one copy per Connection, so it's on the Connection. More... | |
timeval | start_time |
Timekeeping - TCH 30 June 98. More... | |
int | d_serverLogCount |
Server logging w. multiconnection - TCH July 00 Use one "hidden" endpoint for outgoing logs (?), standard per-endpoint logs with augmented names for incoming. To make a hidden endpoint we create d_endpoints[0] and increment the d_numEndpoints, but DON'T pass it d_numConnectedEndpoints (although it should be safe to do so, since it should never truly become connected, but we might have to "fake" it to get it to log correctly). More... | |
vrpn_int32 | d_serverLogMode |
char * | d_serverLogName |
vrpn_Endpoint_IP *(* | d_endpointAllocator )(vrpn_Connection *, vrpn_int32 *) |
vrpn_bool | d_updateEndpoint |
Constructor for a Loopback connection that will basically just pass messages between objects that are connected to it. It offers no external connections, via IP or any other mechanism. It is useful if you want to make the client and server in the same connection and you don't need to have anything else connect.
Definition at line 874 of file vrpn_Connection.h.
|
protected |
Make a client connection. To access this from user code, call vrpn_create_server_connection() with a service name of 'loopback:'. For now, we don't enable logging on a Loopback connection.
Definition at line 6312 of file vrpn_Connection.C.
References vrpn_ConnectionManager::addConnection(), CONNECTED, vrpn_Connection::connectionStatus, and vrpn_ConnectionManager::instance().
|
virtual |
Definition at line 6322 of file vrpn_Connection.C.
References vrpn_ConnectionManager::deleteConnection(), and vrpn_ConnectionManager::instance().
|
inlinevirtual |
Returns vrpn_true if the connection has been established, vrpn_false if not (For a networkless connection, this is equivalent to doing_okay()).
Reimplemented from vrpn_Connection.
Definition at line 898 of file vrpn_Connection.h.
|
inlinevirtual |
Returns vrpn_true if the connection is okay, vrpn_false if not.
Reimplemented from vrpn_Connection.
Definition at line 894 of file vrpn_Connection.h.
|
virtual |
Call each time through program main loop to handle receiving any incoming messages and sending any packed messages. Returns -1 on error, 0 otherwise. Optional argument is TOTAL time to block on select() calls; there may be multiple calls to select() per call to mainloop(), and this timeout will be divided evenly between them.
Implements vrpn_Connection.
Definition at line 6329 of file vrpn_Connection.C.
|
inlineprotectedvirtual |
send pending report, clear the buffer.
This function was protected, now is public, so we can use it to send out intermediate results without calling mainloop
Implements vrpn_Connection.
Definition at line 910 of file vrpn_Connection.h.
|
friend |
Create a server connection of arbitrary type (VRPN UDP/TCP, TCP, File, Loopback, MPI).
Returns NULL if the name is not understood or the connection cannot be created. WARNING: May not be thread safe. To create a VRPN TCP/UDP server, use a name like: vrpn:machine_name_or_ip:port machine_name_or_ip:port machine_name_or_ip :port (This port on any network card.) To create an MPI server, use a name like: mpi:MPI_COMM_WORLD mpi:comm_number When done with the object, call removeReference() on it (which will delete it if there are no other references).
Definition at line 5358 of file vrpn_Connection.C.