78 lines
1.8 KiB
C++
78 lines
1.8 KiB
C++
/**
|
|
* @file include/ActivOneApi/IStreamHandler.h
|
|
*
|
|
* @brief Header for the IStreamHandler class.
|
|
*/
|
|
|
|
#if (!defined ACTIV_ONE_API_ISTREAM_HANDLER_H)
|
|
#define ACTIV_ONE_API_ISTREAM_HANDLER_H
|
|
|
|
#include "ActivOneApi/External.h"
|
|
|
|
#include "ActivOneApi/TypeDefinitions.h"
|
|
|
|
//! Activ namespace.
|
|
namespace Activ
|
|
{
|
|
|
|
//! OneApi namespace.
|
|
namespace OneApi
|
|
{
|
|
|
|
class Context;
|
|
class StreamMessage;
|
|
|
|
//! IStreamHandler class (see Session::PostRequest).
|
|
class IStreamHandler
|
|
{
|
|
public:
|
|
//! Destructor.
|
|
virtual ~IStreamHandler() { }
|
|
|
|
/**
|
|
* @brief Callback on a stream request.
|
|
*
|
|
* Request messages should be either responded to or rejected. See Session::PostResponse() and Session::RejectRequest().
|
|
*
|
|
* The request message can be stored for later processing by moving it. See StreamMessage::IsValidRequest() for notes about
|
|
* doing this.
|
|
*
|
|
* @param message the request message.
|
|
* @param context for this event.
|
|
*/
|
|
virtual void OnStreamRequest(StreamMessage &message, const Context &context) { }
|
|
|
|
/**
|
|
* @brief Callback on a stream response.
|
|
*
|
|
* The response message may be an error. See StreamMessage::GetStatusCode().
|
|
*
|
|
* @param message the response message.
|
|
* @param context for this event.
|
|
*/
|
|
virtual void OnStreamResponse(StreamMessage &message, const Context &context) { }
|
|
|
|
/**
|
|
* @brief Callback on a stream message.
|
|
*
|
|
* @param message the message.
|
|
* @param context for this event.
|
|
*/
|
|
virtual void OnStreamMessage(StreamMessage &message, const Context &context) { }
|
|
|
|
/**
|
|
* @brief Callback on a stream disconnect.
|
|
*
|
|
* Stream disconnects can occur when the remote side closes the stream or because of a connection break.
|
|
*
|
|
* @param context for this event.
|
|
*/
|
|
virtual void OnStreamDisconnect(const Context &context) { }
|
|
};
|
|
|
|
} // namespace OneApi
|
|
|
|
} // namespace Activ
|
|
|
|
#endif // (!defined ACTIV_ONE_API_ISTREAM_HANDLER_H)
|