---

vrpn_Shared.C File Reference

Defines
		#define	CHECK (a)
		#define	TIMEVAL_NORMALIZE (tiva)
Functions
		timeval	vrpn_TimevalNormalize ( const timeval & in_tv )
		timeval	vrpn_TimevalSum ( const timeval& tv1, const timeval& tv2 )
		timeval	vrpn_TimevalDiff ( const timeval& tv1, const timeval& tv2 )
		timeval	vrpn_TimevalScale (const timeval & tv, double scale)
		int	vrpn_TimevalGreater (const timeval & tv1, const timeval & tv2)
		int	vrpn_TimevalEqual ( const timeval& tv1, const timeval& tv2 )
		double	vrpn_TimevalMsecs ( const timeval& tv )
		timeval	vrpn_MsecsTimeval ( const double dMsecs )
		void	vrpn_SleepMsecs ( double dMsecs )
		vrpn_float64	htond ( vrpn_float64 d )
		vrpn_float64	ntohd (vrpn_float64 d)
		int	vrpn_buffer (char ** insertPt, vrpn_int32 * buflen, const vrpn_int16 value)
			Utility routine for placing a vrpn_int16 into a buffer that is to be sent as a message. More...
		int	vrpn_buffer (char ** insertPt, vrpn_int32 * buflen, const vrpn_uint16 value)
			Utility routine for placing a vrpn_uint16 into a buffer that is to be sent as a message. More...
		int	vrpn_buffer (char ** insertPt, vrpn_int32 * buflen, const vrpn_int32 value)
			Utility routine for placing a vrpn_int32 into a buffer that is to be sent as a message. More...
		int	vrpn_buffer (char ** insertPt, vrpn_int32 * buflen, const vrpn_uint32 value)
			Utility routine for placing a vrpn_uint32 into a buffer that is to be sent as a message. More...
		int	vrpn_buffer (char ** insertPt, vrpn_int32 * buflen, const char value)
			Utility routine for placing a character into a buffer that is to be sent as a message. More...
		int	vrpn_buffer (char ** insertPt, vrpn_int32 * buflen, const vrpn_float32 value)
			Utility routine for placing a vrpn_float32 into a buffer that is to be sent as a message. More...
		int	vrpn_buffer (char ** insertPt, vrpn_int32 * buflen, const vrpn_float64 value)
			Utility routine for placing a vrpn_float64 into a buffer that is to be sent as a message. More...
		int	vrpn_buffer (char ** insertPt, vrpn_int32 * buflen, const timeval t)
			Utility routine for placing a timeval struct into a buffer that is to be sent as a message. More...
		int	vrpn_buffer (char ** insertPt, vrpn_int32 * buflen, const char * string, vrpn_int32 length)
			Utility routine for placing a character string of given length into a buffer that is to be sent as a message. More...
		int	vrpn_unbuffer (const char ** buffer, char * cval)
			Utility routine for taking a character from a buffer that was sent as a message. More...
		int	vrpn_unbuffer (const char ** buffer, vrpn_int16 * lval)
			Utility routine for taking a vrpn_int16 from a buffer that was sent as a message. More...
		int	vrpn_unbuffer (const char ** buffer, vrpn_uint16 * lval)
			Utility routine for taking a vrpn_uint16 from a buffer that was sent as a message. More...
		int	vrpn_unbuffer (const char ** buffer, vrpn_int32 * lval)
			Utility routine for taking a vrpn_int32 from a buffer that was sent as a message. More...
		int	vrpn_unbuffer (const char ** buffer, vrpn_uint32 * lval)
			Utility routine for taking a vrpn_uint32 from a buffer that was sent as a message. More...
		int	vrpn_unbuffer (const char ** buffer, vrpn_float32 * fval)
			Utility routine for taking a vrpn_float32 from a buffer that was sent as a message. More...
		int	vrpn_unbuffer (const char ** buffer, vrpn_float64 * dval)
			Utility routine for taking a vrpn_float64 from a buffer that was sent as a message. More...
		int	vrpn_unbuffer (const char ** buffer, timeval * t)
			Utility routine for taking a struct timeval from a buffer that was sent as a message. More...
		int	vrpn_unbuffer (const char ** buffer, char * string, vrpn_int32 length)
			Utility routine for taking a string of specified length from a buffer that was sent as a message. More...
Variables
		long	lTestEndian
		const int	fLittleEndian

---

Define Documentation

#define CHECK (a)

#define TIMEVAL_NORMALIZE (tiva)

---

Function Documentation

timeval vrpn_TimevalNormalize (const timeval & in_tv)

timeval vrpn_TimevalSum (const timeval & tv1, const timeval & tv2)

timeval vrpn_TimevalDiff (const timeval & tv1, const timeval & tv2)

timeval vrpn_TimevalScale (const timeval & tv, double scale)

int vrpn_TimevalGreater (const timeval & tv1, const timeval & tv2)

int vrpn_TimevalEqual (const timeval & tv1, const timeval & tv2)

double vrpn_TimevalMsecs (const timeval & tv)

timeval vrpn_MsecsTimeval (const double dMsecs)

void vrpn_SleepMsecs (double dMsecs)

vrpn_float64 htond (vrpn_float64 d)

vrpn_float64 ntohd (vrpn_float64 d)

int vrpn_buffer (char ** insertPt, vrpn_int32 * buflen, const vrpn_int16 value)

Utility routine for placing a vrpn_int16 into a buffer that is to be sent as a message.

Handles packing into an unaligned buffer (though this should not be done). Advances the insertPt pointer to just after newly-inserted value. Decreases the buflen (space remaining) by the length of the value. Returns zero on success and -1 on failure.

Part of a family of routines that buffer different VRPN types based on their type (vrpn_buffer is overloaded based on the third parameter type). These routines handle byte-swapping to the VRPN standard wire protocol.

int vrpn_buffer (char ** insertPt, vrpn_int32 * buflen, const vrpn_uint16 value)

Utility routine for placing a vrpn_uint16 into a buffer that is to be sent as a message.

Handles packing into an unaligned buffer (though this should not be done). Advances the insertPt pointer to just after newly-inserted value. Decreases the buflen (space remaining) by the length of the value. Returns zero on success and -1 on failure.

Part of a family of routines that buffer different VRPN types based on their type (vrpn_buffer is overloaded based on the third parameter type). These routines handle byte-swapping to the VRPN standard wire protocol.

int vrpn_buffer (char ** insertPt, vrpn_int32 * buflen, const vrpn_int32 value)

Utility routine for placing a vrpn_int32 into a buffer that is to be sent as a message.

Handles packing into an unaligned buffer (though this should not be done). Advances the insertPt pointer to just after newly-inserted value. Decreases the buflen (space remaining) by the length of the value. Returns zero on success and -1 on failure.

Part of a family of routines that buffer different VRPN types based on their type (vrpn_buffer is overloaded based on the third parameter type). These routines handle byte-swapping to the VRPN standard wire protocol.

int vrpn_buffer (char ** insertPt, vrpn_int32 * buflen, const vrpn_uint32 value)

Utility routine for placing a vrpn_uint32 into a buffer that is to be sent as a message.

Handles packing into an unaligned buffer (though this should not be done). Advances the insertPt pointer to just after newly-inserted value. Decreases the buflen (space remaining) by the length of the value. Returns zero on success and -1 on failure.

Part of a family of routines that buffer different VRPN types based on their type (vrpn_buffer is overloaded based on the third parameter type). These routines handle byte-swapping to the VRPN standard wire protocol.

int vrpn_buffer (char ** insertPt, vrpn_int32 * buflen, const char value)

Utility routine for placing a character into a buffer that is to be sent as a message.

Handles packing into an unaligned buffer (though this should not be done). Advances the insertPt pointer to just after newly-inserted value. Decreases the buflen (space remaining) by the length of the value. Returns zero on success and -1 on failure.

Part of a family of routines that buffer different VRPN types based on their type (vrpn_buffer is overloaded based on the third parameter type). These routines handle byte-swapping to the VRPN standard wire protocol.

int vrpn_buffer (char ** insertPt, vrpn_int32 * buflen, const vrpn_float32 value)

Utility routine for placing a vrpn_float32 into a buffer that is to be sent as a message.

Handles packing into an unaligned buffer (though this should not be done). Advances the insertPt pointer to just after newly-inserted value. Decreases the buflen (space remaining) by the length of the value. Returns zero on success and -1 on failure.

Part of a family of routines that buffer different VRPN types based on their type (vrpn_buffer is overloaded based on the third parameter type). These routines handle byte-swapping to the VRPN standard wire protocol.

int vrpn_buffer (char ** insertPt, vrpn_int32 * buflen, const vrpn_float64 value)

Utility routine for placing a vrpn_float64 into a buffer that is to be sent as a message.

Handles packing into an unaligned buffer (though this should not be done). Advances the insertPt pointer to just after newly-inserted value. Decreases the buflen (space remaining) by the length of the value. Returns zero on success and -1 on failure.

Part of a family of routines that buffer different VRPN types based on their type (vrpn_buffer is overloaded based on the third parameter type). These routines handle byte-swapping to the VRPN standard wire protocol.

int vrpn_buffer (char ** insertPt, vrpn_int32 * buflen, const timeval t)

Utility routine for placing a timeval struct into a buffer that is to be sent as a message.

Handles packing into an unaligned buffer (though this should not be done). Advances the insertPt pointer to just after newly-inserted value. Decreases the buflen (space remaining) by the length of the value. Returns zero on success and -1 on failure.

Part of a family of routines that buffer different VRPN types based on their type (vrpn_buffer is overloaded based on the third parameter type). These routines handle byte-swapping to the VRPN standard wire protocol.

int vrpn_buffer (char ** insertPt, vrpn_int32 * buflen, const char * string, vrpn_int32 length)

Utility routine for placing a character string of given length into a buffer that is to be sent as a message.

Handles packing into an unaligned buffer (though this should not be done). Advances the insertPt pointer to just after newly-inserted value. Decreases the buflen (space remaining) by the length of the value. Returns zero on success and -1 on failure.

Part of a family of routines that buffer different VRPN types based on their type (vrpn_buffer is overloaded based on the third parameter type). These routines handle byte-swapping to the VRPN standard wire protocol.

If the length is specified as -1, then the string will be assumed to be NULL-terminated and will be copied using the string-copy routines.

int vrpn_unbuffer (const char ** buffer, char * cval)

Utility routine for taking a character from a buffer that was sent as a message.

Handles unpacking from an unaligned buffer, because people did this anyway. Advances the reading pointer to just after newly-read value. Assumes that the buffer holds a complete value. Returns zero on success and -1 on failure.

Part of a family of routines that unbuffer different VRPN types based on their type (vrpn_buffer is overloaded based on the third parameter type). These routines handle byte-swapping to and from the VRPN defined wire protocol.

int vrpn_unbuffer (const char ** buffer, vrpn_int16 * lval)

Utility routine for taking a vrpn_int16 from a buffer that was sent as a message.

Handles unpacking from an unaligned buffer, because people did this anyway. Advances the reading pointer to just after newly-read value. Assumes that the buffer holds a complete value. Returns zero on success and -1 on failure.

Part of a family of routines that unbuffer different VRPN types based on their type (vrpn_buffer is overloaded based on the third parameter type). These routines handle byte-swapping to and from the VRPN defined wire protocol.

int vrpn_unbuffer (const char ** buffer, vrpn_uint16 * lval)

Utility routine for taking a vrpn_uint16 from a buffer that was sent as a message.

Handles unpacking from an unaligned buffer, because people did this anyway. Advances the reading pointer to just after newly-read value. Assumes that the buffer holds a complete value. Returns zero on success and -1 on failure.

Part of a family of routines that unbuffer different VRPN types based on their type (vrpn_buffer is overloaded based on the third parameter type). These routines handle byte-swapping to and from the VRPN defined wire protocol.

int vrpn_unbuffer (const char ** buffer, vrpn_int32 * lval)

Utility routine for taking a vrpn_int32 from a buffer that was sent as a message.

Handles unpacking from an unaligned buffer, because people did this anyway. Advances the reading pointer to just after newly-read value. Assumes that the buffer holds a complete value. Returns zero on success and -1 on failure.

Part of a family of routines that unbuffer different VRPN types based on their type (vrpn_buffer is overloaded based on the third parameter type). These routines handle byte-swapping to and from the VRPN defined wire protocol.

int vrpn_unbuffer (const char ** buffer, vrpn_uint32 * lval)

Utility routine for taking a vrpn_uint32 from a buffer that was sent as a message.

Handles unpacking from an unaligned buffer, because people did this anyway. Advances the reading pointer to just after newly-read value. Assumes that the buffer holds a complete value. Returns zero on success and -1 on failure.

Part of a family of routines that unbuffer different VRPN types based on their type (vrpn_buffer is overloaded based on the third parameter type). These routines handle byte-swapping to and from the VRPN defined wire protocol.

int vrpn_unbuffer (const char ** buffer, vrpn_float32 * fval)

Utility routine for taking a vrpn_float32 from a buffer that was sent as a message.

Handles unpacking from an unaligned buffer, because people did this anyway. Advances the reading pointer to just after newly-read value. Assumes that the buffer holds a complete value. Returns zero on success and -1 on failure.

Part of a family of routines that unbuffer different VRPN types based on their type (vrpn_buffer is overloaded based on the third parameter type). These routines handle byte-swapping to and from the VRPN defined wire protocol.

int vrpn_unbuffer (const char ** buffer, vrpn_float64 * dval)

Utility routine for taking a vrpn_float64 from a buffer that was sent as a message.

Handles unpacking from an unaligned buffer, because people did this anyway. Advances the reading pointer to just after newly-read value. Assumes that the buffer holds a complete value. Returns zero on success and -1 on failure.

Part of a family of routines that unbuffer different VRPN types based on their type (vrpn_buffer is overloaded based on the third parameter type). These routines handle byte-swapping to and from the VRPN defined wire protocol.

int vrpn_unbuffer (const char ** buffer, timeval * t)

Utility routine for taking a struct timeval from a buffer that was sent as a message.

Handles unpacking from an unaligned buffer, because people did this anyway. Advances the reading pointer to just after newly-read value. Assumes that the buffer holds a complete value. Returns zero on success and -1 on failure.

Part of a family of routines that unbuffer different VRPN types based on their type (vrpn_buffer is overloaded based on the third parameter type). These routines handle byte-swapping to and from the VRPN defined wire protocol.

int vrpn_unbuffer (const char ** buffer, char * string, vrpn_int32 length)

Utility routine for taking a string of specified length from a buffer that was sent as a message.

Does NOT handle unpacking from an unaligned buffer, because the semantics of VRPN require message buffers and the values in them to be aligned, in order to reduce the amount of copying that goes on. Advances the read pointer to just after newly-read value. Assumes that the buffer holds a complete value. Returns zero on success and -1 on failure.

Part of a family of routines that unbuffer different VRPN types based on their type (vrpn_buffer is overloaded based on the third parameter type). These routines handle byte-swapping to and from the VRPN defined wire protocol.

If the length is specified as -1, then the string will be assumed to be NULL-terminated and will be read using the string-copy routines. NEVER use this on a string that was packed with other than the NULL-terminating condition, since embedded NULL characters will ruin the argument parsing for any later arguments in the message.

---

Variable Documentation

long lTestEndian [static]

const int fLittleEndian [static]

---