vrpn_Serial.h

Go to the documentation of this file.

#ifndef VRPN_SERIAL_H
#define VRPN_SERIAL_H
 
#include "vrpn_Configure.h" // for VRPN_API
#include <stddef.h>         // For size_t

 
typedef enum {
    vrpn_SER_PARITY_NONE,
    vrpn_SER_PARITY_ODD,
    vrpn_SER_PARITY_EVEN,
    vrpn_SER_PARITY_MARK,
    vrpn_SER_PARITY_SPACE
} vrpn_SER_PARITY;

extern VRPN_API int
vrpn_open_commport(const char *portname, long baud, int charsize = 8,
                   vrpn_SER_PARITY parity = vrpn_SER_PARITY_NONE,
                   bool rts_flow = false);

extern VRPN_API int vrpn_set_rts(int comm);
extern VRPN_API int vrpn_clear_rts(int comm);
 
extern VRPN_API int vrpn_close_commport(int comm);

extern VRPN_API int vrpn_flush_input_buffer(int comm);

extern VRPN_API int vrpn_flush_output_buffer(int comm);

extern VRPN_API int vrpn_drain_output_buffer(int comm);

extern VRPN_API int
vrpn_read_available_characters(int comm, unsigned char *buffer, size_t count);
extern VRPN_API int vrpn_read_available_characters(int comm,
                                                   unsigned char *buffer,
                                                   size_t count,
                                                   struct timeval *timeout);

extern VRPN_API int vrpn_write_characters(int comm, const unsigned char *buffer,
                                          size_t bytes);
extern VRPN_API int vrpn_write_slowly(int comm, const unsigned char *buffer,
                                      size_t bytes, int millisec_delay);
 
#endif