#include <port.h>
Public Member Functions | |
| short | poll_revents () |
| virtual ssize_t | read (void *buf, size_t count)=0 |
| virtual ssize_t | write (void *buf, size_t count)=0 |
| virtual | ~Port () |
Static Public Member Functions | |
| static Port * | create (const char *conn_string, struct pollfd *pollfd_ptr) |
Protected Member Functions | |
| Port (const char *conn_string, struct pollfd *pollfd_ptr) | |
Protected Attributes | |
| const char * | m_conn_string |
| struct pollfd * | m_pollfd_ptr |
Detailed Description
_____ / _ \ / _/ \ \ / / / \ / / _ \ ___ _ ___ ___ ____ ____ ___ _____ _ _ \ / / \ / / _\| | | __| / _ \ | ++ \ | ++ \ / _ \ |_ _|| | | | \ / / / | | | | | ++ | |_| || ++ / | ++_/| |_| | | | | +-+ | \ / / | |_ | |_ | ++ | _ || |\ \ | | | _ | | | | +-+ | / /|___||___||_| |_||_| \|_| |_| |_| |_| |_| |_| ROBOTICS™
File: port.h Desc: Provides the Port class, which acts as one of the two endpoints of the vserial utility. Currently, a port may be either a pseudo terminal or a real serial port. Auth: Iain Peet
Copyright (c) 2010, Clearpath Robotics, Inc. All Rights Reserved
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Clearpath Robotics, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CLEARPATH ROBOTICS, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Please send comments, questions, or patches to skynet@clearpathrobotics.com Port abstract base class. Provides the static create() function, which will instantiate the proper class type for a particular connection string
Constructor & Destructor Documentation
| Port::Port | ( | const char * | conn_string, |
| struct pollfd * | pollfd_ptr | ||
| ) | [protected] |
| Port::~Port | ( | ) | [virtual] |
Member Function Documentation
| Port * Port::create | ( | const char * | conn_string, |
| struct pollfd * | pollfd_ptr | ||
| ) | [static] |
Create a Port instance appropriate to a given connection string.
- Parameters:
-
conn_string The connection string. Known forms: "serial:devname,baud" - describes a real serial endpoint "pty:path" - describe a pty endpoint "path" - fallback if none of the above match, a pty endpoint
- Returns:
- An appropriate Port instance
| short Port::poll_revents | ( | ) |
| virtual ssize_t Port::read | ( | void * | buf, |
| size_t | count | ||
| ) | [pure virtual] |
Implemented in SerialPort, and PtyPort.
| virtual ssize_t Port::write | ( | void * | buf, |
| size_t | count | ||
| ) | [pure virtual] |
Implemented in SerialPort, and PtyPort.
Member Data Documentation
const char* Port::m_conn_string [protected] |
struct pollfd* Port::m_pollfd_ptr [protected] |
The documentation for this class was generated from the following files: