rodbus (.NET API) 1.3.1
Loading...
Searching...
No Matches
rodbus Namespace Reference

Classes

class  AddressFilter
 Filter used to restrict which IP addresses may communicate with a server More...
 
class  AddressRange
 Range of 16-bit addresses sent in a request from the client to the server More...
 
class  BitValue
 Index/value tuple of a bit type More...
 
class  ClientChannel
 Abstract representation of a client communication channel. More...
 
class  Database
 Class used to add, remove, update, and retrieve values More...
 
class  DecodeLevel
 Controls the decoding of transmitted and received data at the application, frame, and physical layer More...
 
class  DeviceMap
 Maps endpoint handlers to Modbus address More...
 
interface  IAuthorizationHandler
 User implemented interface defines which request and roles are allowed for different functions when implementing Modbus security. More...
 
interface  IBitReadCallback
 Callbacks received when reading coils or discrete inputs More...
 
interface  IClientStateListener
 Callback for monitoring the state of a TCP/TLS connection state More...
 
interface  ILogger
 Logging interface that receives the log messages and writes them somewhere. More...
 
interface  IPortStateListener
 Callback interface for receiving updates about the state of a serial port More...
 
interface  IRegisterReadCallback
 Callbacks received when reading reading holding or input registers More...
 
interface  IWriteCallback
 Callback methods received from asynchronous write operations More...
 
interface  IWriteHandler
 Interface used to handle write requests received from the client More...
 
class  LoggingConfig
 Logging configuration options More...
 
class  ParamException
 Error type that indicates a bad parameter or bad programmer logic More...
 
class  RegisterValue
 Index/value tuple of a register type More...
 
class  RequestException
 Error information returned from asynchronous functions calls. More...
 
class  RequestParam
 Address and timeout parameters for requests More...
 
class  RetryStrategy
 Retry strategy configuration. More...
 
class  Runtime
 Handle to the underlying runtime More...
 
class  RuntimeConfig
 Runtime configuration More...
 
class  SerialPortSettings
 Serial port settings More...
 
class  Server
 Handle to the running server. The server runs on a background task until this class is destroyed. More...
 
class  TlsClientConfig
 TLS client configuration More...
 
class  TlsServerConfig
 TLS server configuration More...
 
class  WriteResult
 Describes to the server if a write operation was successful or not. More...
 

Enumerations

enum  AppDecodeLevel
 Controls how transmitted and received message at the application layer are decoded at the INFO log level More...
 
enum  Authorization
 Authorization result used by IAuthorizationHandler More...
 
enum  CertificateMode
 Determines how the certificate(s) presented by the peer are validated More...
 
enum  ClientState
 State of the client connection. More...
 
enum  DataBits
 Number of bits per character More...
 
enum  FlowControl
 Flow control modes More...
 
enum  FrameDecodeLevel
 Controls how the transmitted and received frames are decoded at the INFO log level More...
 
enum  LogLevel
 Log level More...
 
enum  LogOutputFormat
 Describes how each log event is formatted More...
 
enum  MinTlsVersion
 Minimum TLS version to allow More...
 
enum  ModbusException
 Error information returned during asynchronous API calls More...
 
enum  Nothing
 A single value enum which is used as a placeholder for futures that don't return a value More...
 
enum  ParamError
 Error type that indicates a bad parameter or bad programmer logic More...
 
enum  Parity
 Parity checking modes More...
 
enum  PhysDecodeLevel
 Controls how data transmitted at the physical layer (TCP, serial, etc) is logged More...
 
enum  PortState
 State of the serial port. More...
 
enum  RequestError
 Error information returned from asynchronous functions calls. More...
 
enum  StopBits
 Number of stop bits More...
 
enum  TimeFormat
 Describes if and how the time will be formatted in log messages More...
 

Enumeration Type Documentation

◆ AppDecodeLevel

Controls how transmitted and received message at the application layer are decoded at the INFO log level

Application-layer messages are referred to as Protocol Data Units (PDUs) in the specification.

◆ Authorization

Authorization result used by IAuthorizationHandler

◆ CertificateMode

Determines how the certificate(s) presented by the peer are validated

This validation always occurs after the handshake signature has been verified.

◆ ClientState

State of the client connection.

Used by the IClientStateListener.

◆ DataBits

Number of bits per character

◆ FlowControl

Flow control modes

◆ FrameDecodeLevel

Controls how the transmitted and received frames are decoded at the INFO log level

Transport-specific framing wraps the application-layer traffic. You'll see these frames called ADUs in the Modbus specification.

On TCP, this is the MBAP decoding. On serial, this controls the serial line PDU.

◆ LogLevel

Log level

Used in ILogger.OnMessage callback to identify the log level of a message.

◆ LogOutputFormat

Describes how each log event is formatted

◆ MinTlsVersion

Minimum TLS version to allow

◆ ModbusException

Error information returned during asynchronous API calls

◆ Nothing

A single value enum which is used as a placeholder for futures that don't return a value

◆ ParamError

Error type that indicates a bad parameter or bad programmer logic

◆ Parity

Parity checking modes

◆ PhysDecodeLevel

Controls how data transmitted at the physical layer (TCP, serial, etc) is logged

◆ PortState

State of the serial port.

Used by the IPortStateListener.

◆ RequestError

Error information returned from asynchronous functions calls.

Unlike ParamError, the values here generally represent spontaneous failures that are outside developer control, e.g. network failures, etc

◆ StopBits

Number of stop bits

◆ TimeFormat

Describes if and how the time will be formatted in log messages