-
Notifications
You must be signed in to change notification settings - Fork 294
/
AsyncSocketBase.hxx
164 lines (128 loc) · 7.24 KB
/
AsyncSocketBase.hxx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
#ifndef ASYNC_SOCKET_BASE_HXX
#define ASYNC_SOCKET_BASE_HXX
#include <deque>
#include <asio.hpp>
#include <boost/bind.hpp>
#include <boost/function.hpp>
#include <boost/enable_shared_from_this.hpp>
#include "DataBuffer.hxx"
#include "StunTuple.hxx"
#define RECEIVE_BUFFER_SIZE 4096 // ?slg? should we shrink this to something closer to MTU (1500 bytes)? !hbr! never actually increase it otherwise re-assembled UDP packets get lost. (was 2048)
namespace reTurn {
class AsyncSocketBaseHandler;
class AsyncSocketBaseDestroyedHandler;
class AsyncSocketBase :
public boost::enable_shared_from_this<AsyncSocketBase>
{
public:
AsyncSocketBase(asio::io_service& ioService);
virtual ~AsyncSocketBase();
virtual unsigned int getSocketDescriptor() = 0;
virtual void registerAsyncSocketBaseHandler(AsyncSocketBaseHandler* handler) { mAsyncSocketBaseHandler = handler; }
/// Note: The following API's are thread safe and queue the request to be handled by the ioService thread
virtual asio::error_code bind(const asio::ip::address& address, unsigned short port) = 0;
virtual void connect(const std::string& address, unsigned short port, bool allowV6) = 0;
/// Note: destination is ignored for TCP and TLS connections
virtual void send(const StunTuple& destination, boost::shared_ptr<DataBuffer>& data); // Send unframed data
virtual void send(const StunTuple& destination, unsigned short channel, boost::shared_ptr<DataBuffer>& data); // send with turn framing
/// Overlapped calls to receive functions have no effect
virtual void receive();
virtual void framedReceive();
virtual void close();
bool isConnected() { return mConnected; }
asio::ip::address& getConnectedAddress() { return mConnectedAddress; }
unsigned short getConnectedPort() { return mConnectedPort; }
virtual void setOnBeforeSocketClosedFp(boost::function<void(unsigned int)> fp) { mOnBeforeSocketCloseFp = fp; }
/// Use these if you already operating within the ioService thread
virtual void doSend(const StunTuple& destination, unsigned short channel, boost::shared_ptr<DataBuffer>& data, unsigned int bufferStartPos=0);
virtual void doSend(const StunTuple& destination, boost::shared_ptr<DataBuffer>& data, unsigned int bufferStartPos=0);
virtual void doReceive();
virtual void doFramedReceive();
/// Class override callbacks
virtual void onConnectSuccess() { assert(false); }
virtual void onConnectFailure(const asio::error_code& e) { assert(false); }
virtual void onReceiveSuccess(const asio::ip::address& address, unsigned short port, boost::shared_ptr<DataBuffer>& data) = 0;
virtual void onReceiveFailure(const asio::error_code& e) = 0;
virtual void onSendSuccess() = 0;
virtual void onSendFailure(const asio::error_code& e) = 0;
/// Utility API
static boost::shared_ptr<DataBuffer> allocateBuffer(unsigned int size);
// Stubbed out async handlers needed by Protocol specific Subclasses of this - the requirement for these
// to be in the base class all revolves around the shared_from_this() use/requirement
virtual void start() { assert(false); }
virtual void stop() { assert(false); }
virtual void handleReadHeader(const asio::error_code& e) { assert(false); }
virtual void handleServerHandshake(const asio::error_code& e) { assert(false); }
virtual void handleTcpResolve(const asio::error_code& ec, asio::ip::tcp::resolver::iterator endpoint_iterator) { assert(false); }
virtual void handleUdpResolve(const asio::error_code& ec, asio::ip::udp::resolver::iterator endpoint_iterator) { assert(false); }
virtual void handleConnect(const asio::error_code& ec, asio::ip::tcp::resolver::iterator endpoint_iterator) { assert(false); }
virtual void handleClientHandshake(const asio::error_code& ec, asio::ip::tcp::resolver::iterator endpoint_iterator) { assert(false); }
protected:
/// Handle completion of a sendData operation.
virtual void handleSend(const asio::error_code& e);
virtual void handleReceive(const asio::error_code& e, std::size_t bytesTransferred);
/// The io_service used to perform asynchronous operations.
asio::io_service& mIOService;
/// Receive Buffer and state
boost::shared_ptr<DataBuffer> mReceiveBuffer;
bool mReceiving;
/// Connected Info and State
asio::ip::address mConnectedAddress;
unsigned short mConnectedPort;
bool mConnected;
/// Handlers
AsyncSocketBaseHandler* mAsyncSocketBaseHandler;
/// Provides an opportunity for the app to clean up, e.g., QoS-related data or resources
/// just before the socket is closed
boost::function<void(unsigned int)> mOnBeforeSocketCloseFp;
private:
virtual void transportSend(const StunTuple& destination, std::vector<asio::const_buffer>& buffers) = 0;
virtual void transportReceive() = 0;
virtual void transportFramedReceive() = 0;
virtual void transportClose() = 0;
virtual const asio::ip::address getSenderEndpointAddress() = 0;
virtual unsigned short getSenderEndpointPort() = 0;
virtual void sendFirstQueuedData();
class SendData
{
public:
SendData(const StunTuple& destination, boost::shared_ptr<DataBuffer>& frameData, boost::shared_ptr<DataBuffer>& data, unsigned int bufferStartPos = 0) :
mDestination(destination), mFrameData(frameData), mData(data), mBufferStartPos(bufferStartPos) {}
StunTuple mDestination;
boost::shared_ptr<DataBuffer> mFrameData;
boost::shared_ptr<DataBuffer> mData;
unsigned int mBufferStartPos;
};
/// Queue of data to send
typedef std::deque<SendData> SendDataQueue;
SendDataQueue mSendDataQueue;
};
typedef boost::shared_ptr<AsyncSocketBase> ConnectionPtr;
}
#endif
/* ====================================================================
Copyright (c) 2007-2008, Plantronics, 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:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. 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.
3. Neither the name of Plantronics 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
OWNER 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.
==================================================================== */