Classes | Namespaces | Macros | Enumerations | Functions
serial.h File Reference
#include <limits>
#include <vector>
#include <string>
#include <cstring>
#include <sstream>
#include <exception>
#include <stdexcept>
#include <serial/v8stdint.h>
Include dependency graph for serial.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  serial::IOException
 
struct  serial::PortInfo
 
class  serial::PortNotOpenedException
 
class  serial::Serial
 
class  serial::SerialException
 
struct  serial::Timeout
 

Namespaces

 serial
 

Macros

#define THROW(exceptionClass, message)
 

Enumerations

enum  serial::bytesize_t { serial::fivebits = 5, serial::sixbits = 6, serial::sevenbits = 7, serial::eightbits = 8 }
 
enum  serial::flowcontrol_t { serial::flowcontrol_none = 0, serial::flowcontrol_software, serial::flowcontrol_hardware }
 
enum  serial::parity_t {
  serial::parity_none = 0, serial::parity_odd = 1, serial::parity_even = 2, serial::parity_mark = 3,
  serial::parity_space = 4
}
 
enum  serial::stopbits_t { serial::stopbits_one = 1, serial::stopbits_two = 2, serial::stopbits_one_point_five }
 

Functions

std::vector< PortInfo > serial::list_ports ()
 

Detailed Description

Author
William Woodall wjwwo.nosp@m.od@g.nosp@m.mail..nosp@m.com
John Harrison ash.g.nosp@m.ti@g.nosp@m.mail..nosp@m.com
Version
0.1

LICENSE

The MIT License

Copyright (c) 2012 William Woodall

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

DESCRIPTION

This provides a cross platform interface for interacting with Serial Ports.

Definition in file serial.h.

Macro Definition Documentation

#define THROW (   exceptionClass,
  message 
)
Value:
throw exceptionClass(__FILE__, \
__LINE__, (message) )

Definition at line 48 of file serial.h.



serial
Author(s): William Woodall , John Harrison
autogenerated on Thu Jan 9 2020 07:18:58