tcp_connection.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 */
28 
29 
30 #pragma once
31 
32 #include "../api_network.h"
33 #include "../../Core/IOData/iodevice.h"
34 
35 namespace clan
36 {
39 
40 class SocketName;
41 class Event;
42 
44 class CL_API_NETWORK TCPConnection : public IODevice
45 {
48 
49 public:
50  TCPConnection();
51 
55  TCPConnection(const SocketName &remote);
56 
61  TCPConnection(const SocketName &remote, const SocketName &local);
62 
67  TCPConnection(int socket, bool close_socket);
68 
69  ~TCPConnection();
70 
74 
75 public:
76 
80  int get_handle() const;
81 
85  SocketName get_local_name() const;
86 
90  SocketName get_remote_name() const;
91 
95  Event get_read_event();
96 
100  Event get_write_event();
101 
105 
106 public:
107 
111  void connect(const SocketName &remote);
112 
117  void connect(const SocketName &remote, const SocketName &local);
118 
123  void set_handle(int socket, bool close_socket);
124 
126  void disconnect_graceful();
127 
129  void disconnect_abortive();
130 
132  void set_nodelay(bool enable = true);
133 
141  void set_keep_alive(bool enable, int timeout = 0, int interval = 0);
142 
146 
147 private:
149 };
150 
151 }
152 
I/O Device interface.
Definition: iodevice.h:51
Socket name; container class for an IP address and port.
Definition: socket_name.h:45
TCP connection socket I/O device.
Definition: tcp_connection.h:44
OS level event.
Definition: Core/System/event.h:48