/usr/include/svxlink/AsyncSerial.h is in libasynccore-dev 15.11-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 | /**
@file AsyncSerial.h
@brief A class for using asynchronous serial communications
@author Tobias Blomberg / SM0SVX
@date 2004-08-02
This file contains a class that is used to communicate over an
asynchronous serial link (e.g. RS-232 port).
\verbatim
Async - A library for programming event driven applications
Copyright (C) 2003-2014 Tobias Blomberg / SM0SVX
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
\endverbatim
*/
/** @example AsyncSerial_demo.cpp
An example of how to use the Serial class
*/
#ifndef SERIAL_INCLUDED
#define SERIAL_INCLUDED
/****************************************************************************
*
* System Includes
*
****************************************************************************/
#include <sigc++/sigc++.h>
#include <termios.h>
#include <unistd.h>
#include <string>
/****************************************************************************
*
* Project Includes
*
****************************************************************************/
/****************************************************************************
*
* Local Includes
*
****************************************************************************/
/****************************************************************************
*
* Forward declarations
*
****************************************************************************/
/****************************************************************************
*
* Namespace
*
****************************************************************************/
namespace Async
{
/****************************************************************************
*
* Forward declarations of classes inside of the declared namespace
*
****************************************************************************/
class FdWatch;
class SerialDevice;
/****************************************************************************
*
* Defines & typedefs
*
****************************************************************************/
/****************************************************************************
*
* Exported Global Variables
*
****************************************************************************/
/****************************************************************************
*
* Class definitions
*
****************************************************************************/
/**
@brief A class for using asyncronous serial communications
@author Tobias Blomberg
@date 2004-08-02
@note The flow control code is untested. Report success/failure to me.
This class is used to communicate over an asynchronous serial link
(e.g. RS-232 port). An example of how to use it is shown below.
\include AsyncSerial_demo.cpp
*/
class Serial : public sigc::trackable
{
public:
/**
* @brief A type that defines the possible choices for parity
*/
typedef enum
{
PARITY_NONE, ///< Parity not used
PARITY_EVEN, ///< Use even parity
PARITY_ODD ///< Use odd parity
} Parity;
/**
* @brief A type that defines the possible choices for flow control
*/
typedef enum
{
FLOW_NONE, ///< No flow control in use
FLOW_HW, ///< Use hardware flow control
FLOW_XONOFF ///< Use software (XON/XOFF) flow control
} Flow;
/**
* @brief A type that defines the read/write pins in the serial port
*/
typedef enum
{
PIN_NONE, ///< No pin
PIN_RTS, ///< Output: Request To Send
PIN_DTR, ///< Output: Data Terminal Ready
PIN_CTS, ///< Input: Clear To Send
PIN_DSR, ///< Input: Data Set Ready
PIN_DCD, ///< Input: Data Carrier Detect
PIN_RI ///< Input: Ring Indicate
} Pin;
/**
* @brief The maximum number of characters that can be read at once.
*/
static const int READ_BUFSIZE = 1024;
/**
* @brief Constuctor
* @param serial_port The device name of the serial port to use
*
* This is the constructor for the serial port class. It is possible
* to create multiple instances connected to the same serial port.
* For this to work, the given device name string must be exactly
* the same in all instances.
*/
explicit Serial(const std::string& serial_port);
/**
* @brief Destructor
*/
~Serial(void);
/**
* @brief Setup the serial port communications parameters
* @param speed The serial speed to use
* @param parity The parity to use (see @ref Serial::Parity)
* @param bits The number of bits in each serial word
* @param stop_bits The number of stop bits to use
* @param flow The type of flow control to use
* (see @ref Serial::Flow)
* @return Return \em true on success or else \em false on failure. On
* failure the global variable \em errno will be set to indicate
* the cause of the error.
*
* This function is used to setup the serial communications parameters
* for the serial port. This must be done after calling the open
* function.
*/
bool setParams(int speed, Parity parity, int bits, int stop_bits,
Flow flow);
/**
* @brief Open the serial port
* @param flush Flush (discard) pending RX/TX data on open
* @return Return \em true on success or else \em false on failue. On
* failure the global variable \em errno will be set to indicate
* the cause of the error.
*
* Call this method to open the serial port. No special setup of the
* port is done during the open call. The old setup is saved and restored
* when the port is closed. To setup the port operating
* parameters, use the setParams method after calling open.
* If the open method is called when the port is already opened, it
* just returns \em true without doing anything.
*/
bool open(bool flush=false);
/**
* @brief Close a previously opened serial port
* @return Return \em true on success or else \em false on failue. On
* failure the global variable \em errno will be set to indicate
* the cause of the error.
*
* Use this method to close a previously opened serial port. If the port is
* already closed, \em true is returned and nothing is done.
* If the port has been opened by multiple instances, it will not be
* closed until the last instance has closed it.
*/
bool close(void);
/**
* @brief Write data to the serial port
* @param buf A buffer containing the data to write
* @param count The number of bytes to write
* @returns The number of bytes written is returned on success. If an error
* occurs, -1 is returned and the global variable \em errno is
* set to indicate the cause of the error.
*/
int write(const char *buf, size_t count)
{
return ::write(fd, buf, count);
}
/**
* @brief Set or clear canonical mode
* @return Return \em true on success or else \em false on failue. On
* failure the global variable \em errno will be set to indicate
* the cause of the error.
*
* Call this method to configure the serial port for canonical mode.
* In this mode, a couple of control characters are parsed by the kernel
* driver and interpreted in special ways. Most notably, only whole lines
* of text are sent up to the application. Don't use canonical mode when
* the serial stream is not readable text that is split into lines with
* a line feed character.
*
* This function may be called both before or after the port has been
* opened and the setting is remembered after a close.
*/
bool setCanonical(bool canonical);
/**
* @brief Stop/start input of data
* @param stop Stop input if \em true or start input if \em false
* @return Return \em true on success or else \em false on failue. On
* failure the global variable \em errno will be set to indicate
* the cause of the error.
*
* Use this function to start/stop input of data when the flow control has
* been enabled.
*/
bool stopInput(bool stop);
/**
* @brief Set the state of one of the output pins in the serial port
* @param pin The pin to set. See @ref Serial::Pin.
* @param set If \em true the pin is set, if \em false the pin is cleared
* @return Return \em true on success or else \em false on failue. On
* failure the global variable \em errno will be set to indicate
* the cause of the error.
*
* Use this function to control one of the output pins in the serial port.
* For a list of available pins see @ref Serial::Pin.
*/
bool setPin(Pin pin, bool set);
/**
* @brief Get the state of one of the input pins in the serial port
* @param pin The pin to get the state of. See @ref Serial::Pin.
* @param is_set The result will be returned in this variable.
* @return Return \em true on success or else \em false on failue. On
* failure the global variable \em errno will be set to indicate
* the cause of the error.
*
* Use this function to read the state of one of the input pins in the
* serial port. For a list of available pins see @ref Serial::Pin.
*/
bool getPin(Pin pin, bool &is_set);
/**
* @brief A signal that is emitted when there is data to read
* @param buf A buffer containing the data that has been read
* @param count The number of bytes that was read
* @note For maximum buffer size see @ref Serial::READ_BUFSIZE
*
* This signal is emitted whenever one or more characters has been
* received on the serial port. The buffer is always null-terminated
* but the null is not included in the count.
*/
sigc::signal<void, char*, int> charactersReceived;
protected:
private:
const std::string serial_port;
bool canonical;
int fd;
struct termios port_settings;
SerialDevice *dev;
}; /* class Serial */
} /* namespace */
#endif /* SERIAL_INCLUDED */
/*
* This file has not been truncated
*/
|