2 /// \file m_raw_channel.cc
3 /// Mode class for a raw channel
7 Copyright (C) 2005-2012, Net Direct Inc. (http://www.netdirect.ca/)
8 Portions Copyright (C) 2010 RealVNC Ltd.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
19 See the GNU General Public License in the COPYING file at the
20 root directory of this project for more details.
23 #include "m_raw_channel.h"
24 #include "semaphore.h"
27 #include "protostructs.h"
32 #include "controller.h"
37 #include "protostructs.h"
41 namespace Barry
{ namespace Mode
{
43 ///////////////////////////////////////////////////////////////////////////////
44 // RawChannel SocketDataHandler callback class for data socket
45 class RawChannelSocketHandler
: public SocketRoutingQueue::SocketDataHandler
47 RawChannel
&m_raw_channel
;
49 RawChannelSocketHandler(RawChannel
&raw_channel
)
50 : m_raw_channel(raw_channel
)
52 virtual void DataReceived(Data
&data
)
54 m_raw_channel
.HandleReceivedData(data
);
56 virtual void Error(Barry::Error
&error
)
58 SocketDataHandler::Error(error
);
59 m_raw_channel
.HandleError(error
);
61 virtual ~RawChannelSocketHandler()
65 ///////////////////////////////////////////////////////////////////////////////
66 // RawChannel SocketDataHandler callback class for zero socket
67 class RawChannelZeroSocketHandler
: public SocketRoutingQueue::SocketDataHandler
69 RawChannel
&m_raw_channel
;
71 RawChannelZeroSocketHandler(RawChannel
&raw_channel
)
72 : m_raw_channel(raw_channel
)
74 virtual void DataReceived(Data
&data
)
76 m_raw_channel
.HandleReceivedZeroPacket(data
);
78 virtual void Error(Barry::Error
&error
)
80 SocketDataHandler::Error(error
);
81 m_raw_channel
.HandleError(error
);
83 virtual ~RawChannelZeroSocketHandler()
87 ///////////////////////////////////////////////////////////////////////////////
88 // RawChannel Mode class
90 RawChannel::RawChannel(Controller
&con
, RawChannelDataCallback
&callback
)
91 : Mode(con
, Controller::RawChannel
)
92 , m_callback(&callback
)
94 , m_zero_registered(false)
95 , m_pending_error(NULL
)
97 CheckQueueAvailable();
101 RawChannel::RawChannel(Controller
&con
)
102 : Mode(con
, Controller::RawChannel
)
104 , m_send_buffer(NULL
)
105 , m_zero_registered(false)
106 , m_pending_error(NULL
)
108 CheckQueueAvailable();
112 void RawChannel::CheckQueueAvailable()
114 if( !m_con
.HasQueue() ) {
115 throw Barry::Error("RawChannel: No routing queue set in controller");
119 void RawChannel::InitBuffer()
121 m_send_buffer
= new unsigned char[SB_CHANNELPACKET_HEADER_SIZE
+ SB_CHANNELPACKET_MAX_DATA_SIZE
];
124 RawChannel::~RawChannel()
126 UnregisterZeroSocketInterest();
128 delete[] m_send_buffer
;
130 delete m_pending_error
;
133 void RawChannel::OnOpen()
135 // Enable sequence packets so that DataSendAck callback and close can be
137 m_zero_registered
= true;
138 SocketRoutingQueue::SocketDataHandlerPtr zeroCallback
;
139 zeroCallback
.reset(new RawChannelZeroSocketHandler(*this));
140 m_con
.GetQueue()->RegisterInterest(0, zeroCallback
);
141 // Get socket data packets routed to this class as well if a
142 // callback was provided, otherside just get the data packets
143 // placed into a queue for the socket.
145 SocketRoutingQueue::SocketDataHandlerPtr callback
;
146 callback
.reset(new RawChannelSocketHandler(*this));
147 m_socket
->UnregisterInterest();
148 m_socket
->RegisterInterest(callback
);
151 // sockets already register themselves by default,
152 // so no need to do anything in this case
157 void RawChannel::HandleReceivedZeroPacket(Data
&data
)
159 Protocol::CheckSize(data
, SB_PACKET_HEADER_SIZE
);
160 MAKE_PACKETPTR_BUF(packet
, data
.GetData());
162 if( packet
->socket
!= 0 ) {
163 UnregisterZeroSocketInterest();
164 SetPendingError("RawChannel: Got packet not for socket-zero");
167 switch( btohs(packet
->command
) )
169 case SB_COMMAND_CLOSE_SOCKET
:
170 case SB_COMMAND_REMOTE_CLOSE_SOCKET
:
171 // Stop listening to socket 0 messages
172 // so that socket close work.
173 UnregisterZeroSocketInterest();
175 m_callback
->ChannelClose();
180 UnregisterZeroSocketInterest();
182 m_callback
->ChannelError("RawChannel: Got unexpected socket zero packet");
185 SetPendingError("RawChannel: Got unexpected socket zero packet");
192 void RawChannel::HandleReceivedData(Data
&data
)
194 // Only ever called in callback mode
195 ValidateDataPacket(data
);
196 MAKE_CHANNELPACKETPTR_BUF(packet
, data
.GetData());
198 // Should be a socket packet for us, so remove packet headers
199 Data
partial(packet
->u
.data
, data
.GetSize() - SB_CHANNELPACKET_HEADER_SIZE
);
201 m_callback
->DataReceived(partial
);
204 SetPendingError("RawChannel: Received data to handle when in non-callback mode");
208 void RawChannel::HandleError(Barry::Error
&error
)
210 std::ostringstream errorOss
;
211 errorOss
<< "RawChannel: Socket error received, what: " << error
.what();
214 m_callback
->ChannelError(errorOss
.str().c_str());
217 SetPendingError(errorOss
.str().c_str());
221 void RawChannel::UnregisterZeroSocketInterest()
223 if( m_zero_registered
) {
224 m_con
.GetQueue()->UnregisterInterest(0);
225 m_zero_registered
= false;
229 void RawChannel::SetPendingError(const char *msg
)
231 if( !m_pending_error
) {
232 m_pending_error
= new std::string(msg
);
236 ///////////////////////////////////////////////////////////////////////////////
239 void RawChannel::Send(Data
&data
, int timeout
)
241 size_t packetSize
= SB_CHANNELPACKET_HEADER_SIZE
+ data
.GetSize();
243 if( packetSize
> SB_CHANNELPACKET_HEADER_SIZE
+ SB_CHANNELPACKET_MAX_DATA_SIZE
) {
244 throw Barry::Error("RawChannel: send data size larger than MaximumPacketSize");
247 if( m_pending_error
) {
248 throw Barry::Error(*m_pending_error
);
251 // setup header and copy data in
252 MAKE_CHANNELPACKETPTR_BUF(packet
, m_send_buffer
);
253 packet
->size
= htobs(packetSize
);
254 std::memcpy(packet
->u
.data
, data
.GetData(), data
.GetSize());
256 Data
toSend(m_send_buffer
, packetSize
);
257 m_socket
->SyncSend(toSend
, timeout
);
259 if( m_pending_error
) {
260 throw Barry::Error(*m_pending_error
);
264 void RawChannel::Receive(Data
&data
,int timeout
)
267 throw std::logic_error("RawChannel: Receive called when channel was created with a callback");
270 if( m_pending_error
) {
271 throw Barry::Error(*m_pending_error
);
274 // Receive into a buffer
275 m_socket
->Receive(m_receive_data
, timeout
);
276 // Then transfer across, skipping the header
277 ValidateDataPacket(m_receive_data
);
278 MAKE_CHANNELPACKETPTR_BUF(packet
, m_receive_data
.GetData());
280 size_t len
= packet
->size
- SB_CHANNELPACKET_HEADER_SIZE
;
281 memcpy(data
.GetBuffer(), packet
->u
.data
, len
);
282 data
.ReleaseBuffer(len
);
286 void RawChannel::ValidateDataPacket(Data
&data
)
288 Protocol::CheckSize(data
, SB_CHANNELPACKET_HEADER_SIZE
);
289 MAKE_CHANNELPACKETPTR_BUF(packet
, data
.GetData());
290 if( packet
->size
!= data
.GetSize() ) {
292 throw std::logic_error("RawChannel: Data size doesn't match packet size");
296 size_t RawChannel::MaximumSendSize()
298 return SB_CHANNELPACKET_MAX_DATA_SIZE
;
301 }} // namespace Barry::Mode