ISerializer Class Reference

ISerializer interface. More...

#include <ISerializer.h>

Inheritance diagram for ISerializer:

Public Member Functions
virtual const std::string &	getName () const =0
virtual std::string	parseCategory (const std::string &request)=0
	Get category identification from request. More...
virtual std::unique_ptr< DpaTask >	parseRequest (const std::string &request)=0
	Parse DPA request. More...
virtual std::string	parseConfig (const std::string &request)=0
	Parse confiquration request. More...
virtual std::string	encodeConfig (const std::string &request, const std::string &response)=0
	Encode confiquration response. More...
virtual std::string	getLastError () const =0
	Get last error string. More...
virtual std::string	encodeAsyncAsDpaRaw (const DpaMessage &dpaMessage) const =0
	Encode Asynchronous DPA message. More...
virtual	~ISerializer ()

Detailed Description

ISerializer interface.

Constructor & Destructor Documentation

~ISerializer()

virtual ISerializer::~ISerializer ( )

inlinevirtual

Member Function Documentation

encodeAsyncAsDpaRaw()

virtual std::string ISerializer::encodeAsyncAsDpaRaw ( const DpaMessage &  dpaMessage ) const

pure virtual

Encode Asynchronous DPA message.

Parameters

[in]

dpaMessage

message to be encoded

Returns

serialized message

Passed asynchronous DPA message is serialized in an appropriate form.

Implemented in JsonSerializer, and SimpleSerializer.

encodeConfig()

virtual std::string ISerializer::encodeConfig ( const std::string &  request, const std::string &  response  )

pure virtual

Encode confiquration response.

Parameters

[in]	request	original configuration request
[in]	response	string with response phrase

Returns

string with configuration response

Encode configuration response based on original configuration request and passed response phrase.

Implemented in JsonSerializer, and SimpleSerializer.

getLastError()

virtual std::string ISerializer::getLastError ( ) const

pure virtual

Get last error string.

Returns

error string

Serializer sets last error string as the result of last serialization.

Implemented in JsonSerializer, and SimpleSerializer.

getName()

virtual const std::string& ISerializer::getName ( ) const

pure virtual

Implemented in JsonSerializer, and SimpleSerializer.

parseCategory()

virtual std::string ISerializer::parseCategory ( const std::string &  request )

pure virtual

Get category identification from request.

Parameters

[in]

request

incoming request to be examined

Returns

category string

Extracts a category identification from incoming request. It allows to identify appropriate parsing method to be used in next processing.

Implemented in JsonSerializer, and SimpleSerializer.

parseConfig()

virtual std::string ISerializer::parseConfig ( const std::string &  request )

pure virtual

Parse confiquration request.

Parameters

[in]

request

configuration request

Returns

string with configuration

It expects incoming configuration request (detected by parseCategory). It parses the request and return configuration string. The only switch mode forwarding | operational | service is supported now. Returned string may be empty in case of error.

Implemented in JsonSerializer, and SimpleSerializer.

parseRequest()

virtual std::unique_ptr<DpaTask> ISerializer::parseRequest ( const std::string &  request )

pure virtual

Parse DPA request.

Parameters

[in]

request

incoming DPA request

Returns

DPA task created from incomming request

It expects incoming DPA request (detected by parseCategory). It parses DPA request and create DpaTask. DpaTask may be empty in case of error.

Implemented in JsonSerializer, and SimpleSerializer.

---

The documentation for this class was generated from the following file:

• daemon/include/ISerializer.h