uuid::modbus::Request Class Reference

Request message. More...

#include <uuid/modbus.h>

Inheritance diagram for uuid::modbus::Request:

Collaboration diagram for uuid::modbus::Request:

Public Member Functions
	Request (uint16_t device, uint8_t function_code, uint16_t timeout_ms, const std::shared_ptr< Response > &response)
	Create a new request message (not directly useful). More...
virtual uint16_t	encode (frame_buffer_t &frame)
	Encode this request and store it in a message frame buffer. More...
uint16_t	device () const
	Get the destination device address. More...
uint8_t	function_code () const
	Get the function code of the request. More...
uint16_t	timeout_ms () const
	Get the timeout to wait for a response in milliseconds. More...
Response &	response () const
	Get the response object. More...

Private Attributes
const uint16_t	device_
const uint8_t	function_code_
const uint16_t	timeout_ms_
const std::shared_ptr< Response >	response_

Detailed Description

Request message.

This will be created when a request is submitted and then discarded when the response is updated with the outcome.

Since

0.1.0

Definition at line 349 of file modbus.h.

Constructor & Destructor Documentation

Request()

uuid::modbus::Request::Request	(	uint16_t	device,
		uint8_t	function_code,
		uint16_t	timeout_ms,
		const std::shared_ptr< Response > &	response
	)

Create a new request message (not directly useful).

Parameters

[in]	device	Destination device address.
[in]	function_code	Function code of the request.
[in]	timeout_ms	Timeout to wait for a response in milliseconds.
[in]	response	Response object.

Since

0.1.0

Definition at line 32 of file generic_functions.cpp.

Member Function Documentation

device()

uint16_t uuid::modbus::Request::device ( ) const

inline

Get the destination device address.

Returns

Remote device address.

Since

0.1.0

Definition at line 381 of file modbus.h.

encode()

uint16_t uuid::modbus::Request::encode ( frame_buffer_t &  frame )

virtual

Encode this request and store it in a message frame buffer.

Parameters

[out]

frame

Message frame buffer.

Returns

Size of message frame.

Since

0.1.0

Reimplemented in uuid::modbus::RegisterRequest.

Definition at line 38 of file generic_functions.cpp.

function_code()

uint8_t uuid::modbus::Request::function_code ( ) const

inline

Get the function code of the request.

Returns

Request message function code.

Since

0.1.0

Definition at line 389 of file modbus.h.

response()

Response& uuid::modbus::Request::response ( ) const

inline

Get the response object.

Returns

Corresponding response object.

Since

0.1.0

Definition at line 405 of file modbus.h.

timeout_ms()

uint16_t uuid::modbus::Request::timeout_ms ( ) const

inline

Get the timeout to wait for a response in milliseconds.

Returns

Request timeout.

Since

0.1.0

Definition at line 397 of file modbus.h.

Member Data Documentation

device_

const uint16_t uuid::modbus::Request::device_

private

Remote device address.

Since

0.1.0

Definition at line 405 of file modbus.h.

function_code_

const uint8_t uuid::modbus::Request::function_code_

private

Request message function code.

Since

0.1.0

Definition at line 409 of file modbus.h.

response_

const std::shared_ptr<Response> uuid::modbus::Request::response_

private

Corresponding response object.

Since

0.1.0

Definition at line 411 of file modbus.h.

timeout_ms_

const uint16_t uuid::modbus::Request::timeout_ms_

private

Request timeout.

Since

0.1.0

Definition at line 410 of file modbus.h.

---

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

• mcu-uuid-modbus/src/uuid/modbus.h
• mcu-uuid-modbus/src/generic_functions.cpp