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.
24 #include "m_raw_channel.h"
25 #include "semaphore.h"
28 #include "protostructs.h"
33 #include "controller.h"
38 #include "protostructs.h"
42 namespace Barry
{ namespace Mode
{
44 ///////////////////////////////////////////////////////////////////////////////
45 // RawChannel SocketDataHandler callback class for data socket
46 class RawChannelSocketHandler
: public SocketRoutingQueue::SocketDataHandler
48 RawChannel
&m_raw_channel
;
50 RawChannelSocketHandler(RawChannel
&raw_channel
)
51 : m_raw_channel(raw_channel
)
53 virtual void DataReceived(Data
&data
)
55 m_raw_channel
.HandleReceivedData(data
);
57 virtual void Error(Barry::Error
&error
)
59 SocketDataHandler::Error(error
);
60 m_raw_channel
.HandleError(error
);
62 virtual ~RawChannelSocketHandler()
66 ///////////////////////////////////////////////////////////////////////////////
67 // RawChannel SocketDataHandler callback class for zero socket
68 class RawChannelZeroSocketHandler
: public SocketRoutingQueue::SocketDataHandler
70 RawChannel
&m_raw_channel
;
72 RawChannelZeroSocketHandler(RawChannel
&raw_channel
)
73 : m_raw_channel(raw_channel
)
75 virtual void DataReceived(Data
&data
)
77 m_raw_channel
.HandleReceivedZeroPacket(data
);
79 virtual void Error(Barry::Error
&error
)
81 SocketDataHandler::Error(error
);
82 m_raw_channel
.HandleError(error
);
84 virtual ~RawChannelZeroSocketHandler()
88 ///////////////////////////////////////////////////////////////////////////////
89 // RawChannel Mode class
91 RawChannel::RawChannel(Controller
&con
, RawChannelDataCallback
&callback
)
92 : Mode(con
, Controller::RawChannel
)
93 , m_callback(&callback
)
95 , m_zero_registered(false)
96 , m_pending_error(NULL
)
98 CheckQueueAvailable();
102 RawChannel::RawChannel(Controller
&con
)
103 : Mode(con
, Controller::RawChannel
)
105 , m_send_buffer(NULL
)
106 , m_zero_registered(false)
107 , m_pending_error(NULL
)
109 CheckQueueAvailable();
113 void RawChannel::CheckQueueAvailable()
115 if( !m_con
.HasQueue() ) {
116 throw Barry::Error(_("RawChannel: No routing queue set in controller"));
120 void RawChannel::InitBuffer()
122 m_send_buffer
= new unsigned char[SB_CHANNELPACKET_HEADER_SIZE
+ SB_CHANNELPACKET_MAX_DATA_SIZE
];
125 RawChannel::~RawChannel()
127 UnregisterZeroSocketInterest();
129 delete[] m_send_buffer
;
131 delete m_pending_error
;
134 void RawChannel::OnOpen()
136 // Enable sequence packets so that DataSendAck callback and close can be
138 m_zero_registered
= true;
139 SocketRoutingQueue::SocketDataHandlerPtr zeroCallback
;
140 zeroCallback
.reset(new RawChannelZeroSocketHandler(*this));
141 m_con
.GetQueue()->RegisterInterest(0, zeroCallback
);
142 // Get socket data packets routed to this class as well if a
143 // callback was provided, otherside just get the data packets
144 // placed into a queue for the socket.
146 SocketRoutingQueue::SocketDataHandlerPtr callback
;
147 callback
.reset(new RawChannelSocketHandler(*this));
148 m_socket
->UnregisterInterest();
149 m_socket
->RegisterInterest(callback
);
152 // sockets already register themselves by default,
153 // so no need to do anything in this case
158 void RawChannel::HandleReceivedZeroPacket(Data
&data
)
160 Protocol::CheckSize(data
, SB_PACKET_HEADER_SIZE
);
161 MAKE_PACKETPTR_BUF(packet
, data
.GetData());
163 if( packet
->socket
!= 0 ) {
164 UnregisterZeroSocketInterest();
165 SetPendingError(_("RawChannel: Got packet not for socket-zero"));
168 switch( btohs(packet
->command
) )
170 case SB_COMMAND_CLOSE_SOCKET
:
171 case SB_COMMAND_REMOTE_CLOSE_SOCKET
:
172 // Stop listening to socket 0 messages
173 // so that socket close work.
174 UnregisterZeroSocketInterest();
176 m_callback
->ChannelClose();
181 UnregisterZeroSocketInterest();
183 m_callback
->ChannelError(_("RawChannel: Got unexpected socket zero packet"));
186 SetPendingError(_("RawChannel: Got unexpected socket zero packet"));
193 void RawChannel::HandleReceivedData(Data
&data
)
195 // Only ever called in callback mode
196 ValidateDataPacket(data
);
197 MAKE_CHANNELPACKETPTR_BUF(packet
, data
.GetData());
199 // Should be a socket packet for us, so remove packet headers
200 Data
partial(packet
->u
.data
, data
.GetSize() - SB_CHANNELPACKET_HEADER_SIZE
);
202 m_callback
->DataReceived(partial
);
205 SetPendingError(_("RawChannel: Received data to handle when in non-callback mode"));
209 void RawChannel::HandleError(Barry::Error
&error
)
211 std::ostringstream errorOss
;
212 errorOss
<< _("RawChannel: Socket error received, what: ") << error
.what();
215 m_callback
->ChannelError(errorOss
.str().c_str());
218 SetPendingError(errorOss
.str().c_str());
222 void RawChannel::UnregisterZeroSocketInterest()
224 if( m_zero_registered
) {
225 m_con
.GetQueue()->UnregisterInterest(0);
226 m_zero_registered
= false;
230 void RawChannel::SetPendingError(const char *msg
)
232 if( !m_pending_error
) {
233 m_pending_error
= new std::string(msg
);
237 ///////////////////////////////////////////////////////////////////////////////
240 void RawChannel::Send(Data
&data
, int timeout
)
242 size_t packetSize
= SB_CHANNELPACKET_HEADER_SIZE
+ data
.GetSize();
244 if( packetSize
> SB_CHANNELPACKET_HEADER_SIZE
+ SB_CHANNELPACKET_MAX_DATA_SIZE
) {
245 throw Barry::Error(_("RawChannel: send data size larger than MaximumPacketSize"));
248 if( m_pending_error
) {
249 throw Barry::Error(*m_pending_error
);
252 // setup header and copy data in
253 MAKE_CHANNELPACKETPTR_BUF(packet
, m_send_buffer
);
254 packet
->size
= htobs(packetSize
);
255 std::memcpy(packet
->u
.data
, data
.GetData(), data
.GetSize());
257 Data
toSend(m_send_buffer
, packetSize
);
258 m_socket
->SyncSend(toSend
, timeout
);
260 if( m_pending_error
) {
261 throw Barry::Error(*m_pending_error
);
265 void RawChannel::Receive(Data
&data
,int timeout
)
268 throw std::logic_error(_("RawChannel: Receive called when channel was created with a callback"));
271 if( m_pending_error
) {
272 throw Barry::Error(*m_pending_error
);
275 // Receive into a buffer
276 m_socket
->Receive(m_receive_data
, timeout
);
277 // Then transfer across, skipping the header
278 ValidateDataPacket(m_receive_data
);
279 MAKE_CHANNELPACKETPTR_BUF(packet
, m_receive_data
.GetData());
281 size_t len
= packet
->size
- SB_CHANNELPACKET_HEADER_SIZE
;
282 memcpy(data
.GetBuffer(), packet
->u
.data
, len
);
283 data
.ReleaseBuffer(len
);
287 void RawChannel::ValidateDataPacket(Data
&data
)
289 Protocol::CheckSize(data
, SB_CHANNELPACKET_HEADER_SIZE
);
290 MAKE_CHANNELPACKETPTR_BUF(packet
, data
.GetData());
291 if( packet
->size
!= data
.GetSize() ) {
293 throw std::logic_error(_("RawChannel: Data size doesn't match packet size"));
297 size_t RawChannel::MaximumSendSize()
299 return SB_CHANNELPACKET_MAX_DATA_SIZE
;
302 }} // namespace Barry::Mode