imtrest::IProtocolEngine

#include <IProtocolEngine.h>

Inherits istd::IPolymorphic.

Inherited by imtrest::CHttpProtocolEngineComp [virtual], imtrest::CTcpProtocolEngineComp [virtual], and imtrest::CWebSocketProtocolEngineComp [virtual].

Public Types
enum	StatusCode {   SC_NONE , SC_OK , SC_OPERATION_NOT_AVAILABLE , SC_RESOURCE_NOT_AVAILABLE ,   SC_NOT_MODIFIED , SC_UNAUTHORIZED , SC_INTERNAL_ERROR , SC_CONTINUE ,   SC_SWITCHING_PROTOCOLS , SC_PROCESSING , SC_CREATED , SC_ACCEPTED ,   SC_NON_AUTHORITATIVE_INFORMATION , SC_NO_CONTENT , SC_RESET_CONTENT , SC_PARTIAL_CONTENT ,   SC_MULTI_STATUS , SC_ALREADY_REPORTED , SC_IM_USED , SC_MULTIPLE_CHOICES ,   SC_MOVED_PERMANENTLY , SC_MOVED_TEMPORARILY , SC_SEE_OTHER , SC_USE_PROXY ,   SC_RESERVE , SC_TEMPORARY_REDIRECT , SC_PERMANENT_REDIRECT , SC_BAD_REQUEST ,   SC_PAYMENT_REQUIRED , SC_FORBIDDEN , SC_NOT_FOUND , SC_METHOD_NOT_ALLOWED ,   SC_NOT_ACCEPTABLE , SC_PROXY_AUTHENTICATION_REQUIRED , SC_REQUEST_TIMEOUT , SC_CONFLICT ,   SC_GONE , SC_LENGTH_REQUIRED , SC_PRECONDITION_FAILED , SC_PAYLOAD_TOO_LARGE ,   SC_URI_TOO_LONG , SC_UNSUPPORTED_MEDIA_TYPE , SC_RANGE_NOT_SATISFIABLE , SC_EXPECTATION_FAILED ,   SC_I_AM_A_TEAPOT , SC_MISDIRECTED_REQUEST , SC_UNPROCESSABLE_ENTITY , SC_LOCKED ,   SC_FAILED_DEPENDENCY , SC_UPGRADE_REQUIRED , SC_PRECONDITION_REQUIRED , SC_TOO_MANY_REQUESTS ,   SC_REQUEST_HEADER_FIELDS_TOO_LARGE , SC_RETRY_WITH , SC_UNAVAILABLE_FOR_LEGAL_REASONS , SC_INTERNAL_SERVER_ERROR ,   SC_NOT_IMPLEMENTED , SC_BAD_GATEWAY , SC_SERVICE_UNAVAILABLE , SC_GATEWAY_TIMEOUT ,   SC_HTTP_VERSION_NOT_SUPPORTED , SC_VARIANT_ALSO_NEGOTIATES , SC_INSUFFICIENT_STORAGE , SC_LOOP_DETECTED ,   SC_BANDWIDTH_LIMIT_EXCEEDED , SC_NOT_EXTENDED , SC_NETWORK_AUTHENTICATION_REQUIRED , SC_UNKNOWN_ERROR ,   SC_WEB_SERVER_IS_DOWN , SC_CONNECTION_TIMED_OUT , SC_ORIGIN_IS_UNREACHABLE , SC_A_TIMEOUT_OCCURRED ,   SC_SSL_HANDSHAKE_FAILED , SC_INVALID_SSL_CERTIFICATE }

Public Member Functions
virtual QByteArray	GetProtocolTypeId () const =0
virtual const iser::IVersionInfo *	GetProtocolVersion () const =0
virtual bool	GetProtocolStatusCode (int statusCode, int &protocolStatusCode, QByteArray &statusCodeLiteral) const =0
virtual imtrest::IRequestUniquePtr	CreateRequest (const IRequestServlet &requestHandler) const =0
virtual imtrest::IRequestUniquePtr	CreateRequestForSend (const IRequestServlet &requestHandler, int statusCode, const QByteArray &data, const QByteArray &dataTypeId) const =0
virtual imtrest::IResponseUniquePtr	CreateResponse (const IRequest &request, int statusCode, const QByteArray &data, const QByteArray &dataTypeId) const =0

Detailed Description

Interface for core-level protocol definition.

Definition at line 21 of file IProtocolEngine.h.

Member Enumeration Documentation

StatusCode

enum imtrest::IProtocolEngine::StatusCode

Enumerator
SC_NONE	No status is available.
SC_OK	Operation could be successfull processed.
SC_OPERATION_NOT_AVAILABLE	Requested operation is not available or implemented.
SC_RESOURCE_NOT_AVAILABLE	Requested resource is not available.
SC_NOT_MODIFIED	Requested resource was not modified since the last call. The caller should use the last version of the resource on the client side.
SC_UNAUTHORIZED	Operation is not authorized.
SC_INTERNAL_ERROR	Internal server error.

Definition at line 24 of file IProtocolEngine.h.

Member Function Documentation

CreateRequest()

virtual imtrest::IRequestUniquePtr imtrest::IProtocolEngine::CreateRequest ( const IRequestServlet &  requestHandler ) const

pure virtual

Create request based on the incomming data.

Parameters

socketPtr	Socket instance for reading the incommming data
requestHandler	Instance to process the request after all data has been read.

CreateRequestForSend()

virtual imtrest::IRequestUniquePtr imtrest::IProtocolEngine::CreateRequestForSend ( const IRequestServlet &  requestHandler, int  statusCode, const QByteArray &  data, const QByteArray &  dataTypeId  ) const

pure virtual

Create request for sending data.

Parameters

data	The response data.
request	Related request.

CreateResponse()

virtual imtrest::IResponseUniquePtr imtrest::IProtocolEngine::CreateResponse ( const IRequest &  request, int  statusCode, const QByteArray &  data, const QByteArray &  dataTypeId  ) const

pure virtual

Create reponse for a given request.

Parameters

data	The response data.
request	Related request.

GetProtocolStatusCode()

virtual bool imtrest::IProtocolEngine::GetProtocolStatusCode ( int  statusCode, int &  protocolStatusCode, QByteArray &  statusCodeLiteral  ) const

pure virtual

Get the protocol-specific code for the engine's status.

GetProtocolTypeId()

virtual QByteArray imtrest::IProtocolEngine::GetProtocolTypeId ( ) const

pure virtual

Get type-ID of the used protocol.

GetProtocolVersion()

virtual const iser::IVersionInfo * imtrest::IProtocolEngine::GetProtocolVersion ( ) const

pure virtual

Get the protocol version.