AsyncSerial.h

Go to the documentation of this file.

/**************************************************************************************************
 Software License Agreement (BSD License)

 Copyright (c) 2011-2013, LAR toolkit developers - University of Aveiro - http://lars.mec.ua.pt
 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 the University of Aveiro 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 THE COPYRIGHT HOLDER OR
 CONTRIBUTORS 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.
***************************************************************************************************/
// ORIGINAL BELOW
/*
 * File:   AsyncSerial.h
 * Author: Terraneo Federico
 * Distributed under the Boost Software License, Version 1.0.
 * Created on September 7, 2009, 10:46 AM
 */

#ifndef ASYNCSERIAL_H
#define ASYNCSERIAL_H

#include <vector>
#include <boost/asio.hpp>
#include <boost/bind.hpp>
#include <boost/thread.hpp>
#include <boost/utility.hpp>
#include <boost/function.hpp>
#include <boost/shared_array.hpp>

class AsyncSerialImpl;

class AsyncSerial:private
   boost::noncopyable {
 public:
   AsyncSerial (  );
    
   AsyncSerial ( const std::string & devname, unsigned int baud_rate,
                 boost::asio::serial_port_base::parity opt_parity =
                 boost::asio::serial_port_base::parity ( boost::asio::
                                                         serial_port_base::parity::none ),
                 boost::asio::serial_port_base::character_size opt_csize =
                 boost::asio::serial_port_base::character_size ( 8 ),
                 boost::asio::serial_port_base::flow_control opt_flow =
                 boost::asio::serial_port_base::flow_control ( boost::
                                                               asio::serial_port_base::flow_control::
                                                               none ),
                 boost::asio::serial_port_base::stop_bits opt_stop =
                 boost::asio::serial_port_base::stop_bits ( boost::asio::
                                                            serial_port_base::stop_bits::
                                                            one ) );

   void

    
      open ( const std::string & devname, unsigned int baud_rate,
             boost::asio::serial_port_base::parity opt_parity =
             boost::asio::serial_port_base::parity ( boost::asio::serial_port_base::
                                                     parity::none ),
             boost::asio::serial_port_base::character_size opt_csize =
             boost::asio::serial_port_base::character_size ( 8 ),
             boost::asio::serial_port_base::flow_control opt_flow =
             boost::asio::serial_port_base::flow_control ( boost::asio::
                                                           serial_port_base::flow_control::
                                                           none ),
             boost::asio::serial_port_base::stop_bits opt_stop =
             boost::asio::serial_port_base::stop_bits ( boost::asio::
                                                        serial_port_base::stop_bits::
                                                        one ) );

   bool
   isOpen (  ) const;

   bool
   errorStatus (  ) const;

   void
     close (  );

   void
     write ( const char *data, size_t size );

   void
     write ( const std::vector < char >&data );

   void
     writeString ( const std::string & s );

   virtual ~
   AsyncSerial (  ) = 0;

   static const int
     readBufferSize = 512;
 private:

   void
     doRead (  );

   void
     readEnd ( const boost::system::error_code & error, size_t bytes_transferred );

   void
     doWrite (  );

   void
     writeEnd ( const boost::system::error_code & error );

   void
     doClose (  );

   boost::shared_ptr <
      AsyncSerialImpl >
      pimpl;

 protected:

   void
     setErrorStatus ( bool e );

   void
    
      setReadCallback ( const boost::function < void ( const char *, size_t ) >
                        &callback );

   void
     clearReadCallback (  );

};

class CallbackAsyncSerial:
public AsyncSerial
{
 public:
   CallbackAsyncSerial (  );

   CallbackAsyncSerial ( const std::string & devname, unsigned int baud_rate,
                         boost::asio::serial_port_base::parity opt_parity =
                         boost::asio::serial_port_base::parity ( boost::
                                                                 asio::serial_port_base::parity::
                                                                 none ),
                         boost::asio::serial_port_base::character_size opt_csize =
                         boost::asio::serial_port_base::character_size ( 8 ),
                         boost::asio::serial_port_base::flow_control opt_flow =
                         boost::asio::serial_port_base::flow_control ( boost::
                                                                       asio::serial_port_base::flow_control::
                                                                       none ),
                         boost::asio::serial_port_base::stop_bits opt_stop =
                         boost::asio::serial_port_base::stop_bits ( boost::
                                                                    asio::serial_port_base::stop_bits::
                                                                    one ) );

   void
     setCallback ( const boost::function < void ( const char *, size_t ) > &callback );

   void
     clearCallback (  );

   virtual ~ CallbackAsyncSerial (  );
};

#endif //ASYNCSERIAL_H