serial_port.h

Go to the documentation of this file.

/*
This program is distributed under the terms of the 'MIT license'. The text
of this licence follows...

Copyright (c) 2006 J.D.Medhurst (a.k.a. Tixy)

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.
*/

#ifndef SERIAL_PORT_H
#define SERIAL_PORT_H

class SerialPort
    {
public:
    static SerialPort* New();

    virtual int Open(unsigned port) =0;

    virtual int Initialise(unsigned baud) =0;

    virtual int Out(const uint8_t* data, size_t size, unsigned timeout) =0;

    virtual int In(uint8_t* data, size_t maxSize, unsigned timeout) =0;

    virtual void Close() =0;

    virtual ~SerialPort() =0;

    enum Errors
        {
        ErrorUnspecified    = -100, 
        ErrorInvalidPort    = -101, 
        ErrorPortInUse      = -102, 
        ErrorInvalidSettings= -103, 
        ErrorTransmitError  = -104, 
        ErrorReceiveError   = -105  
        };
    };

 // End of group

#endif