Async Comm
A library for asynchronous serial communication
tcp_client.h
Go to the documentation of this file.
1 /*
2  * Software License Agreement (BSD-3 License)
3  *
4  * Copyright (c) 2019 Rein Appeldoorn.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  *
10  * * Redistributions of source code must retain the above copyright notice, this
11  * list of conditions and the following disclaimer.
12  *
13  * * Redistributions in binary form must reproduce the above copyright notice,
14  * this list of conditions and the following disclaimer in the documentation
15  * and/or other materials provided with the distribution.
16  *
17  * * Neither the name of the copyright holder nor the names of its
18  * contributors may be used to endorse or promote products derived from
19  * this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
38 #ifndef ASYNC_COMM_TCP_CLIENT_H
39 #define ASYNC_COMM_TCP_CLIENT_H
40 
41 #include <string>
42 
43 #include <boost/asio.hpp>
44 #include <boost/function.hpp>
45 
47 #include <async_comm/comm.h>
48 
49 namespace async_comm
50 {
51 
56 class TCPClient : public Comm
57 {
58 public:
65  TCPClient(std::string host = DEFAULT_HOST, uint16_t port = DEFAULT_PORT,
66  MessageHandler& message_handler = default_message_handler_);
67  ~TCPClient();
68 
69 private:
70  static constexpr auto DEFAULT_HOST = "localhost";
71  static constexpr uint16_t DEFAULT_PORT = 16140;
72 
73  bool is_open() override;
74  bool do_init() override;
75  void do_close() override;
76  void do_async_read(const boost::asio::mutable_buffers_1 &buffer,
77  boost::function<void(const boost::system::error_code&, size_t)> handler) override;
78  void do_async_write(const boost::asio::const_buffers_1 &buffer,
79  boost::function<void(const boost::system::error_code&, size_t)> handler) override;
80 
81  std::string host_;
82  uint16_t port_;
83 
84  boost::asio::ip::tcp::socket socket_;
85  boost::asio::ip::tcp::endpoint endpoint_;
86 };
87 
88 } // namespace async_comm
89 
90 #endif // ASYNC_COMM_TCP_CLIENT_H
Abstract base class for an asynchronous communication port.
Definition: comm.h:81
Asynchronous communication class for a TCP client.
Definition: tcp_client.h:56
TCPClient(std::string host=DEFAULT_HOST, uint16_t port=DEFAULT_PORT, MessageHandler &message_handler=default_message_handler_)
Connect to a TCP socket as a client.
Definition: tcp_client.cpp:47
Abstract base class for message handler.