ocpp 0.24.1
A C++ implementation of the Open Charge Point Protocol
Public Member Functions | List of all members
ocpp::v2::DataTransferInterface Class Referenceabstract
Inheritance diagram for ocpp::v2::DataTransferInterface:
ocpp::v2::MessageHandlerInterface ocpp::v2::DataTransfer

Public Member Functions

virtual std::optional< DataTransferResponsedata_transfer_req (const CiString< 255 > &vendorId, const std::optional< CiString< 50 > > &messageId, const std::optional< json > &data)=0
 Sends a DataTransfer.req message to the CSMS using the given parameters. More...
 
virtual std::optional< DataTransferResponsedata_transfer_req (const DataTransferRequest &request)=0
 Sends a DataTransfer.req message to the CSMS using the given request. More...
 
- Public Member Functions inherited from ocpp::v2::MessageHandlerInterface
virtual void handle_message (const EnhancedMessage< MessageType > &message)=0
 Handles the given message from the CSMS. This includes dispatching a CALLRESULT as a response to the incoming message . More...
 

Member Function Documentation

◆ data_transfer_req() [1/2]

virtual std::optional< DataTransferResponse > ocpp::v2::DataTransferInterface::data_transfer_req ( const CiString< 255 > &  vendorId,
const std::optional< CiString< 50 > > &  messageId,
const std::optional< json > &  data 
)
pure virtual

Sends a DataTransfer.req message to the CSMS using the given parameters.

Parameters
vendorId
messageId
data
Returns
DataTransferResponse containing the result from CSMS

Implemented in ocpp::v2::DataTransfer.

◆ data_transfer_req() [2/2]

virtual std::optional< DataTransferResponse > ocpp::v2::DataTransferInterface::data_transfer_req ( const DataTransferRequest request)
pure virtual

Sends a DataTransfer.req message to the CSMS using the given request.

Parameters
requestmessage shall be sent to the CSMS
Returns
DataTransferResponse containing the result from CSMS. In case no response is received from the CSMS because the message timed out or the charging station is offline, std::nullopt is returned

Implemented in ocpp::v2::DataTransfer.


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