generic-library/poco
1
0
Fork 0
mirror of https://github.com/pocoproject/poco.git synced 2025-10-28 11:31:53 +01:00
Code Issues Projects Releases Wiki Activity

trunk: add websocket class

Browse Source
This commit is contained in:
Marian Krivos
2012-02-05 12:29:46 +00:00
parent 7d7c02c579
commit d066518edd
4 changed files with 914 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

265
Net/include/Poco/Net/WebSocket.h Normal file
View File

@@ -0,0 +1,265 @@
//
// WebSocket.h
//
// $Id: //poco/1.4/Net/include/Poco/Net/WebSocket.h#1 $
//
// Library: Net
// Package: WebSocket
// Module: WebSocket
//
// Definition of the WebSocket class.
//
// Copyright (c) 2012, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// Permission is hereby granted, free of charge, to any person or organization
// obtaining a copy of the software and accompanying documentation covered by
// this license (the "Software") to use, reproduce, display, distribute,
// execute, and transmit the Software, and to prepare derivative works of the
// Software, and to permit third-parties to whom the Software is furnished to
// do so, all subject to the following:
//
// The copyright notices in the Software and this entire statement, including
// the above license grant, this restriction and the following disclaimer,
// must be included in all copies of the Software, in whole or in part, and
// all derivative works of the Software, unless such copies or derivative
// works are solely in the form of machine-executable object code generated by
// a source language processor.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
#ifndef Net_WebSocket_INCLUDED
#define Net_WebSocket_INCLUDED
#include "Poco/Net/Net.h"
#include "Poco/Net/StreamSocket.h"
#include "Poco/Net/HTTPCredentials.h"
namespace Poco {
namespace Net {
class WebSocketImpl;
class HTTPServerRequest;
class HTTPServerResponse;
class HTTPClientSession;
class Net_API WebSocket: public StreamSocket
/// This class implements a WebSocket according
/// to the WebSocket protocol specification in RFC 6455.
///
/// Both client-side and server-side WebSockets
/// are supported.
///
/// Server-side WebSockets are usually created from within
/// a HTTPRequestHandler.
///
/// Client-side WebSockets are created using a HTTPClientSession.
///
/// Note that special frames like PING must be handled at
/// application level. In the case of a PING, a PONG message
/// must be returned.
{
public:
enum Mode
{
WS_SERVER, /// Server-side WebSocket.
WS_CLIENT /// Client-side WebSocket.
};
enum FrameFlags
/// Frame header flags.
{
FRAME_FLAG_FIN = 0x80, /// FIN bit: final fragment of a multi-fragment message.
FRAME_FLAG_RSV1 = 0x40, /// Reserved for future use. Must be zero.
FRAME_FLAG_RSV2 = 0x20, /// Reserved for future use. Must be zero.
FRAME_FLAG_RSV3 = 0x10, /// Reserved for future use. Must be zero.
};
enum FrameOpcodes
/// Frame header opcodes.
{
FRAME_OP_CONT = 0x00, /// Continuation frame.
FRAME_OP_TEXT = 0x01, /// Text frame.
FRAME_OP_BINARY = 0x02, /// Binary frame.
FRAME_OP_CLOSE = 0x08, /// Close connection.
FRAME_OP_PING = 0x09, /// Ping frame.
FRAME_OP_PONG = 0x0a, /// Pong frame.
FRAME_OP_BITMASK = 0x0f /// Bit mask for opcodes.
};
enum SendFlags
/// Combined header flags and opcodes for use with sendFrame().
{
FRAME_TEXT = FRAME_FLAG_FIN | FRAME_OP_TEXT,
/// Use this for sending a single text (UTF-8) payload frame.
FRAME_BINARY = FRAME_FLAG_FIN | FRAME_OP_BINARY
/// Use this for sending a single binary payload frame.
};
enum StatusCodes
/// StatusCodes for CLOSE frames sent with shutdown().
{
WS_NORMAL_CLOSE = 1000,
WS_ENDPOINT_GOING_AWAY = 1001,
WS_PROTOCOL_ERROR = 1002,
WS_PAYLOAD_NOT_ACCEPTABLE = 1003,
WS_RESERVED = 1004,
WS_RESERVED_NO_STATUS_CODE = 1005,
WS_RESERVED_ABNORMAL_CLOSE = 1006,
WS_MALFORMED_PAYLOAD = 1007,
WS_POLICY_VIOLATION = 1008,
WS_PAYLOAD_TOO_BIG = 1009,
WS_EXTENSION_REQUIRED = 1010,
WS_UNEXPECTED_CONDITION = 1011,
WS_RESERVED_TLS_FAILURE = 1015
};
enum ErrorCodes
/// These error codes can be obtained from a WebSocketException
/// to determine the exact cause of the error.
{
WS_ERR_NO_HANDSHAKE = 1,
/// No Connection: Upgrade or Upgrade: websocket header in handshake request.
WS_ERR_HANDSHAKE_NO_VERSION = 2,
/// No Sec-WebSocket-Version header in handshake request.
WS_ERR_HANDSHAKE_UNSUPPORTED_VERSION = 3,
/// Unsupported WebSocket version requested by client.
WS_ERR_HANDSHAKE_NO_KEY = 4,
/// No Sec-WebSocket-Key header in handshake request.
WS_ERR_HANDSHAKE_ACCEPT = 5,
/// No Sec-WebSocket-Accept header or wrong value.
WS_ERR_UNAUTHORIZED = 6,
/// The server rejected the username or password for authentication.
WS_ERR_PAYLOAD_TOO_BIG = 10,
/// Payload too big for supplied buffer.
WS_ERR_INCOMPLETE_FRAME = 11
/// Incomplete frame received.
};
WebSocket(HTTPServerRequest& request, HTTPServerResponse& response);
/// Creates a server-side WebSocket from within a
/// HTTPRequestHandler.
///
/// First verifies that the request is a valid WebSocket upgrade
/// request. If so, completes the handshake by sending
/// a proper 101 response.
///
/// Throws an exception if the request is not a proper WebSocket
/// upgrade request.
WebSocket(HTTPClientSession& cs, HTTPRequest& request, HTTPResponse& response);
/// Creates a client-side WebSocket, using the given
/// HTTPClientSession and HTTPRequest for the initial handshake
/// (HTTP Upgrade request).
///
/// Additional HTTP headers for the initial handshake request
/// (such as Origin or Sec-WebSocket-Protocol) can be given
/// in the request object.
///
/// The result of the handshake can be obtained from the response
/// object.
WebSocket(HTTPClientSession& cs, HTTPRequest& request, HTTPResponse& response, HTTPCredentials& credentials);
/// Creates a client-side WebSocket, using the given
/// HTTPClientSession and HTTPRequest for the initial handshake
/// (HTTP Upgrade request).
///
/// The given credentials are used for authentication
/// if requested by the server.
///
/// Additional HTTP headers for the initial handshake request
/// (such as Origin or Sec-WebSocket-Protocol) can be given
/// in the request object.
///
/// The result of the handshake can be obtained from the response
/// object.
virtual ~WebSocket();
/// Destroys the StreamSocket.
WebSocket& operator = (const Socket& socket);
/// Assignment operator.
///
/// Releases the socket's SocketImpl and
/// attaches the SocketImpl from the other socket and
/// increments the reference count of the SocketImpl.
void shutdown();
/// Sends a Close control frame to the server end of
/// the connection to initiate an orderly shutdown
/// of the connection.
void shutdown(Poco::UInt16 statusCode, const std::string& statusMessage = "");
/// Sends a Close control frame to the server end of
/// the connection to initiate an orderly shutdown
/// of the connection.
int sendFrame(const void* buffer, int length, int flags = FRAME_TEXT);
/// Sends the contents of the given buffer through
/// the socket as a single frame.
///
/// Values from the FrameFlags, FrameOpcodes and SendFlags enumerations
/// can be specified in flags.
///
/// Returns the number of bytes sent, which may be
/// less than the number of bytes specified.
///
/// Certain socket implementations may also return a negative
/// value denoting a certain condition.
int receiveFrame(void* buffer, int length, int& flags);
/// Receives a frame from the socket and stores it
/// in buffer. Up to length bytes are received. If
/// the frame's payload is larger, a WebSocketException
/// is thrown and the WebSocket connection must be
/// terminated.
///
/// Returns the number of bytes received.
/// A return value of 0 means a graceful shutdown
/// of the connection from the peer.
///
/// Throws a TimeoutException if a receive timeout has
/// been set and nothing is received within that interval.
/// Throws a NetException (or a subclass) in case of other errors.
///
/// The frame flags and opcode (FrameFlags and FrameOpcodes)
/// is stored in flags.
Mode mode() const;
/// Returns WS_SERVER if the WebSocket is a server-side
/// WebSocket, or WS_CLIENT otherwise.
static const std::string WEBSOCKET_VERSION;
/// The WebSocket protocol version supported (13).
protected:
static WebSocketImpl* accept(HTTPServerRequest& request, HTTPServerResponse& response);
static WebSocketImpl* connect(HTTPClientSession& cs, HTTPRequest& request, HTTPResponse& response, HTTPCredentials& credentials);
static WebSocketImpl* completeHandshake(HTTPClientSession& cs, HTTPResponse& response, const std::string& key);
static std::string computeAccept(const std::string& key);
static std::string createKey();
private:
WebSocket();
static const std::string WEBSOCKET_GUID;
static HTTPCredentials _defaultCreds;
};
} } // namespace Poco::Net
#endif // Net_WebSocket_INCLUDED

126
Net/include/Poco/Net/WebSocketImpl.h Normal file
View File

@@ -0,0 +1,126 @@
//
// WebSocketImpl.h
//
// $Id: //poco/1.4/Net/include/Poco/Net/WebSocketImpl.h#1 $
//
// Library: Net
// Package: WebSocket
// Module: WebSocketImpl
//
// Definition of the StreamSocketImpl class.
//
// Copyright (c) 2012, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// Permission is hereby granted, free of charge, to any person or organization
// obtaining a copy of the software and accompanying documentation covered by
// this license (the "Software") to use, reproduce, display, distribute,
// execute, and transmit the Software, and to prepare derivative works of the
// Software, and to permit third-parties to whom the Software is furnished to
// do so, all subject to the following:
//
// The copyright notices in the Software and this entire statement, including
// the above license grant, this restriction and the following disclaimer,
// must be included in all copies of the Software, in whole or in part, and
// all derivative works of the Software, unless such copies or derivative
// works are solely in the form of machine-executable object code generated by
// a source language processor.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
#ifndef Net_WebSocketImpl_INCLUDED
#define Net_WebSocketImpl_INCLUDED
#include "Poco/Net/StreamSocketImpl.h"
#include "Poco/Random.h"
namespace Poco {
namespace Net {
class Net_API WebSocketImpl: public StreamSocketImpl
/// This class implements a WebSocket, according
/// to the WebSocket protocol described in RFC 6455.
{
public:
WebSocketImpl(StreamSocketImpl* pStreamSocketImpl, bool mustMaskPayload);
/// Creates a StreamSocketImpl using the given native socket.
// StreamSocketImpl
virtual int sendBytes(const void* buffer, int length, int flags);
/// Sends a WebSocket protocol frame.
virtual int receiveBytes(void* buffer, int length, int flags);
/// Receives a WebSocket protocol frame.
virtual SocketImpl* acceptConnection(SocketAddress& clientAddr);
virtual void connect(const SocketAddress& address);
virtual void connect(const SocketAddress& address, const Poco::Timespan& timeout);
virtual void connectNB(const SocketAddress& address, const Poco::Timespan& timeout);
virtual void bind(const SocketAddress& address, bool reuseAddress = false);
virtual void bind6(const SocketAddress& address, bool reuseAddress = false, bool ipV6Only = false);
virtual void listen(int backlog = 64);
virtual void close();
virtual void shutdownReceive();
virtual void shutdownSend();
virtual void shutdown();
virtual int sendTo(const void* buffer, int length, const SocketAddress& address, int flags = 0);
virtual int receiveFrom(void* buffer, int length, SocketAddress& address, int flags = 0);
virtual void sendUrgent(unsigned char data);
virtual bool secure() const;
// Internal
int frameFlags() const;
/// Returns the frame flags of the most recently received frame.
bool mustMaskPayload() const;
/// Returns true if the payload must be masked.
protected:
enum
{
FRAME_FLAG_MASK = 0x80,
MAX_HEADER_LENGTH = 14
};
virtual ~WebSocketImpl();
private:
WebSocketImpl();
StreamSocketImpl* _pStreamSocketImpl;
int _frameFlags;
bool _mustMaskPayload;
Poco::Random _rnd;
};
//
// inlines
//
inline int WebSocketImpl::frameFlags() const
{
return _frameFlags;
}
inline bool WebSocketImpl::mustMaskPayload() const
{
return _mustMaskPayload;
}
} } // namespace Poco::Net
#endif // Net_WebSocketImpl_INCLUDED