dnp3 (.NET API) 1.1.0
|
Classes | |
class | AddressFilter |
Outstation address filter More... | |
class | AnalogInput |
analog_input point More... | |
class | AnalogInputConfig |
Analog configuration More... | |
class | AnalogOutputStatus |
analog_output_status point More... | |
class | AnalogOutputStatusConfig |
Analog Output Status configuration More... | |
class | ApplicationIin |
Application-controlled IIN bits More... | |
class | AssociationConfig |
Association configuration More... | |
class | AssociationId |
Association identifier More... | |
class | BinaryInput |
binary_input point More... | |
class | BinaryInputConfig |
Binary Input configuration More... | |
class | BinaryOutputStatus |
binary_output_status point More... | |
class | BinaryOutputStatusConfig |
Binary Output Status configuration More... | |
class | Classes |
Class 0, 1, 2 and 3 config More... | |
class | ClassZeroConfig |
Controls which types are reported during a Class 0 read. More... | |
class | CommandException |
Result of a command More... | |
class | CommandSet |
Builder type used to construct command requests More... | |
class | ConnectStrategy |
Timing parameters for connection attempts More... | |
class | ControlCode |
CROB (Group12Var1) control code More... | |
class | ControlField |
APDU Control field More... | |
class | Counter |
counter point More... | |
class | CounterConfig |
Counter configuration More... | |
class | Database |
Internal database access More... | |
class | DatabaseHandle |
handle used to perform transactions on the database More... | |
class | DecodeLevel |
Controls the decoding of transmitted and received data at the application, transport, link, and physical layers More... | |
class | DoubleBitBinaryInput |
double_bit_binary_input point More... | |
class | DoubleBitBinaryInputConfig |
Double-Bit Binary Input configuration More... | |
class | EndpointList |
List of IP endpoints. More... | |
class | EventBufferConfig |
Maximum number of events for each type More... | |
class | EventClasses |
Event classes More... | |
class | Flags |
Collection of individual flag bits represented by an underlying mask value More... | |
class | FrozenCounter |
frozen_counter point More... | |
class | FrozenCounterConfig |
Frozen Counter configuration More... | |
class | Group12Var1 |
Control Relay Output Block More... | |
class | HeaderInfo |
Information about the object header and specific variation More... | |
interface | IAssociationHandler |
Callbacks for a particular outstation association More... | |
interface | IAssociationInformation |
Informational callbacks about the current state of an outstation association More... | |
interface | IClientStateListener |
Callback for monitoring the client TCP connection state More... | |
interface | ICommandTaskCallback |
Handler for command tasks More... | |
interface | IConnectionStateListener |
Callback interface for connection state events More... | |
interface | IControlHandler |
Callbacks for handling controls More... | |
class | Iin |
Pair of IIN bytes More... | |
class | Iin1 |
First IIN byte More... | |
class | Iin2 |
Second IIN byte More... | |
interface | ILinkStatusCallback |
Handler for link status check More... | |
interface | ILogger |
Logging interface that receives the log messages and writes them somewhere. More... | |
interface | IOutstationApplication |
Dynamic information required by the outstation from the user application More... | |
interface | IOutstationInformation |
Informational callbacks that the outstation doesn't rely on to function More... | |
interface | IPortStateListener |
Callback interface for receiving updates about the state of a serial port More... | |
interface | IReadHandler |
General handler that will receive all values read from the outstation. More... | |
interface | IReadTaskCallback |
Handler for read tasks More... | |
interface | IRestartTaskCallback |
Handler for restart tasks More... | |
interface | ITimeSyncTaskCallback |
Handler for time synchronization tasks More... | |
class | LinkStatusException |
Errors that can occur during a manually initiated link status check. See MasterChannel.CheckLinkStatus More... | |
class | LoggingConfig |
Logging configuration options More... | |
class | MasterChannel |
Represents a communication channel for a master station More... | |
class | MasterChannelConfig |
Generic configuration for a MasterChannel More... | |
class | OctetString |
Octet String point More... | |
class | Outstation |
Outstation handle More... | |
class | OutstationConfig |
Outstation configuration More... | |
class | OutstationFeatures |
Optional outstation features that can be enabled or disabled More... | |
class | OutstationServer |
TCP server that listens for connections and routes the messages to outstations. More... | |
class | ParamException |
Error type used throughout the library More... | |
class | PollId |
Poll identifier More... | |
class | ReadException |
Errors that can occur during a read operation More... | |
class | Request |
Custom request More... | |
class | RequestHeader |
Application-layer header for requests More... | |
class | ResponseHeader |
Response header information More... | |
class | RestartDelay |
Restart delay used by IOutstationApplication.ColdRestart and IOutstationApplication.WarmRestart More... | |
class | RestartException |
Errors that can occur during a cold/warm restart operation More... | |
class | RetryStrategy |
Retry strategy configuration. More... | |
class | Runtime |
Handle to the underlying runtime More... | |
class | RuntimeConfig |
Runtime configuration More... | |
class | SerialSettings |
Serial port settings More... | |
class | Timestamp |
Timestamp value More... | |
class | TimeSyncException |
Possible errors that can occur during a time synchronization procedure More... | |
class | TlsClientConfig |
TLS client configuration More... | |
class | TlsServerConfig |
TLS server configuration More... | |
class | UpdateOptions |
Options that control how the update is performed. More... | |
class | UtcTimestamp |
Timestamp value returned by IAssociationHandler.GetCurrentTime. More... | |
Enumerations | |
enum | AppDecodeLevel { Nothing = 0 , Header = 1 , ObjectHeaders = 2 , ObjectValues = 3 } |
Controls how transmitted and received application-layer fragments are decoded at the INFO log level More... | |
enum | AutoTimeSync { None = 0 , Lan = 1 , NonLan = 2 } |
Automatic time synchronization configuration More... | |
enum | BroadcastAction { Processed = 0 , IgnoredByConfiguration = 1 , BadObjectHeaders = 2 , UnsupportedFunction = 3 } |
Enumeration describing how the outstation processed a broadcast request More... | |
enum | CertificateMode { AuthorityBased = 0 , SelfSigned = 1 } |
Determines how the certificate(s) presented by the peer are validated More... | |
enum | ClientState { Disabled = 0 , Connecting = 1 , Connected = 2 , WaitAfterFailedConnect = 3 , WaitAfterDisconnect = 4 , Shutdown = 5 } |
State of the client connection. More... | |
enum | CommandError { Ok = 0 , BadStatus = 1 , HeaderMismatch = 2 , TooManyRequests = 3 , BadResponse = 4 , ResponseTimeout = 5 , WriteError = 6 , NoConnection = 7 , Shutdown = 8 , AssociationRemoved = 9 } |
Result of a command More... | |
enum | CommandMode { DirectOperate = 0 , SelectBeforeOperate = 1 } |
Command operation mode More... | |
enum | CommandStatus { Success = 0 , Timeout = 1 , NoSelect = 2 , FormatError = 3 , NotSupported = 4 , AlreadyActive = 5 , HardwareError = 6 , Local = 7 , TooManyOps = 8 , NotAuthorized = 9 , AutomationInhibit = 10 , ProcessingLimited = 11 , OutOfRange = 12 , DownstreamLocal = 13 , AlreadyComplete = 14 , Blocked = 15 , Canceled = 16 , BlockedOtherMaster = 17 , DownstreamFail = 18 , NonParticipating = 19 , Unknown = 20 } |
Enumeration received from an outstation in response to command request More... | |
enum | ConnectionState { Connected = 0 , Disconnected = 1 } |
Outstation connection state for connection-oriented transports, e.g. TCP More... | |
enum | DataBits { Five = 0 , Six = 1 , Seven = 2 , Eight = 3 } |
Number of bits per character More... | |
enum | DoubleBit { Intermediate = 0 , DeterminedOff = 1 , DeterminedOn = 2 , Indeterminate = 3 } |
Double-bit binary input value More... | |
enum | EventAnalogInputVariation { Group32Var1 = 0 , Group32Var2 = 1 , Group32Var3 = 2 , Group32Var4 = 3 , Group32Var5 = 4 , Group32Var6 = 5 , Group32Var7 = 6 , Group32Var8 = 7 } |
Event analog variation More... | |
enum | EventAnalogOutputStatusVariation { Group42Var1 = 0 , Group42Var2 = 1 , Group42Var3 = 2 , Group42Var4 = 3 , Group42Var5 = 4 , Group42Var6 = 5 , Group42Var7 = 6 , Group42Var8 = 7 } |
Event analog output status variation More... | |
enum | EventBinaryInputVariation { Group2Var1 = 0 , Group2Var2 = 1 , Group2Var3 = 2 } |
Event binary input variation More... | |
enum | EventBinaryOutputStatusVariation { Group11Var1 = 0 , Group11Var2 = 1 } |
Event binary output status variation More... | |
enum | EventClass { None = 0 , Class1 = 1 , Class2 = 2 , Class3 = 3 } |
Event class More... | |
enum | EventCounterVariation { Group22Var1 = 0 , Group22Var2 = 1 , Group22Var5 = 2 , Group22Var6 = 3 } |
Event counter variation More... | |
enum | EventDoubleBitBinaryInputVariation { Group4Var1 = 0 , Group4Var2 = 1 , Group4Var3 = 2 } |
Event double-bit binary input variation More... | |
enum | EventFrozenCounterVariation { Group23Var1 = 0 , Group23Var2 = 1 , Group23Var5 = 2 , Group23Var6 = 3 } |
Event frozen counter variation More... | |
enum | EventMode { Detect = 0 , Force = 1 , Suppress = 2 } |
Controls how events are processed when updating values in the database. More... | |
enum | FlowControl { None = 0 , Software = 1 , Hardware = 2 } |
Flow control modes More... | |
enum | FreezeResult { Ok = 0 , ParameterError = 1 , NotSupported = 2 } |
Result of a freeze operation More... | |
enum | FreezeType { ImmediateFreeze = 0 , FreezeAndClear = 1 } |
Freeze operation type More... | |
enum | FunctionCode { Confirm = 0 , Read = 1 , Write = 2 , Select = 3 , Operate = 4 , DirectOperate = 5 , DirectOperateNoResponse = 6 , ImmediateFreeze = 7 , ImmediateFreezeNoResponse = 8 , FreezeClear = 9 , FreezeClearNoResponse = 10 , FreezeAtTime = 11 , FreezeAtTimeNoResponse = 12 , ColdRestart = 13 , WarmRestart = 14 , InitializeData = 15 , InitializeApplication = 16 , StartApplication = 17 , StopApplication = 18 , SaveConfiguration = 19 , EnableUnsolicited = 20 , DisableUnsolicited = 21 , AssignClass = 22 , DelayMeasure = 23 , RecordCurrentTime = 24 , OpenFile = 25 , CloseFile = 26 , DeleteFile = 27 , GetFileInfo = 28 , AuthenticateFile = 29 , AbortFile = 30 , Response = 31 , UnsolicitedResponse = 32 } |
Application layer function code More... | |
enum | LinkDecodeLevel { Nothing = 0 , Header = 1 , Payload = 2 } |
Controls how transmitted and received link frames are decoded at the INFO log level More... | |
enum | LinkErrorMode { Discard = 0 , Close = 1 } |
Controls how errors in parsed link-layer frames are handled. This behavior is configurable for physical layers with built-in error correction like TCP as the connection might be through a terminal server. More... | |
enum | LinkStatusError { Ok = 0 , UnexpectedResponse = 1 , TooManyRequests = 2 , BadResponse = 3 , ResponseTimeout = 4 , WriteError = 5 , NoConnection = 6 , Shutdown = 7 , AssociationRemoved = 8 } |
Errors that can occur during a manually initiated link status check. See MasterChannel.CheckLinkStatus More... | |
enum | LogLevel { Error = 0 , Warn = 1 , Info = 2 , Debug = 3 , Trace = 4 } |
Log level More... | |
enum | LogOutputFormat { Text = 0 , Json = 1 } |
Describes how each log event is formatted More... | |
enum | MinTlsVersion { V12 = 0 , V13 = 1 } |
Minimum TLS version to allow More... | |
enum | Nothing { Nothing = 0 } |
A single value enum which is used as a placeholder for futures that don't return a value More... | |
enum | OperateType { SelectBeforeOperate = 0 , DirectOperate = 1 , DirectOperateNoAck = 2 } |
Enumeration describing how the master requested the control operation More... | |
enum | OpType { Nul = 0 , PulseOn = 1 , PulseOff = 2 , LatchOn = 3 , LatchOff = 4 } |
Operation Type field, used in conjunction with TripCloseCode to specify a control operation More... | |
enum | ParamError { Ok = 0 , InvalidTimeout = 1 , NullParameter = 2 , NoSupport = 3 , AssociationDoesNotExist = 4 , AssociationDuplicateAddress = 5 , InvalidSocketAddress = 6 , InvalidDnp3Address = 7 , InvalidBufferSize = 8 , AddressFilterConflict = 9 , ServerAlreadyStarted = 10 , ServerBindError = 11 , MasterAlreadyShutdown = 12 , RuntimeCreationFailure = 13 , RuntimeDestroyed = 14 , RuntimeCannotBlockWithinAsync = 15 , LoggingAlreadyConfigured = 16 , PointDoesNotExist = 17 , InvalidPeerCertificate = 18 , InvalidLocalCertificate = 19 , InvalidPrivateKey = 20 , InvalidDnsName = 21 , OtherTlsError = 22 } |
Error type used throughout the library More... | |
enum | Parity { None = 0 , Odd = 1 , Even = 2 } |
Parity checking modes More... | |
enum | PhysDecodeLevel { Nothing = 0 , Length = 1 , Data = 2 } |
Controls how data transmitted at the physical layer (TCP, serial, etc) is logged More... | |
enum | PortState { Disabled = 0 , Wait = 1 , Open = 2 , Shutdown = 3 } |
State of the serial port More... | |
enum | QualifierCode { Range8 = 0 , Range16 = 1 , AllObjects = 2 , Count8 = 3 , Count16 = 4 , CountAndPrefix8 = 5 , CountAndPrefix16 = 6 , FreeFormat16 = 7 } |
Qualifier code used in the response More... | |
enum | ReadError { Ok = 0 , TooManyRequests = 1 , BadResponse = 2 , ResponseTimeout = 3 , WriteError = 4 , NoConnection = 5 , Shutdown = 6 , AssociationRemoved = 7 } |
Errors that can occur during a read operation More... | |
enum | ReadType { StartupIntegrity = 0 , Unsolicited = 1 , SinglePoll = 2 , PeriodicPoll = 3 } |
Describes the source of a read event More... | |
enum | ResponseFunction { Response = 0 , UnsolicitedResponse = 1 } |
Type of response More... | |
enum | RestartDelayType { NotSupported = 0 , Seconds = 1 , MilliSeconds = 2 } |
Type of restart delay value. Used by RestartDelay. More... | |
enum | RestartError { Ok = 0 , TooManyRequests = 1 , BadResponse = 2 , ResponseTimeout = 3 , WriteError = 4 , NoConnection = 5 , Shutdown = 6 , AssociationRemoved = 7 } |
Errors that can occur during a cold/warm restart operation More... | |
enum | StaticAnalogInputVariation { Group30Var1 = 0 , Group30Var2 = 1 , Group30Var3 = 2 , Group30Var4 = 3 , Group30Var5 = 4 , Group30Var6 = 5 } |
Static analog variation More... | |
enum | StaticAnalogOutputStatusVariation { Group40Var1 = 0 , Group40Var2 = 1 , Group40Var3 = 2 , Group40Var4 = 3 } |
Static analog output status variation More... | |
enum | StaticBinaryInputVariation { Group1Var1 = 0 , Group1Var2 = 1 } |
Static binary input variation More... | |
enum | StaticBinaryOutputStatusVariation { Group10Var1 = 0 , Group10Var2 = 1 } |
Static binary output status variation More... | |
enum | StaticCounterVariation { Group20Var1 = 0 , Group20Var2 = 1 , Group20Var5 = 2 , Group20Var6 = 3 } |
Static counter variation More... | |
enum | StaticDoubleBitBinaryInputVariation { Group3Var1 = 0 , Group3Var2 = 1 } |
Static double-bit binary input variation More... | |
enum | StaticFrozenCounterVariation { Group21Var1 = 0 , Group21Var2 = 1 , Group21Var5 = 2 , Group21Var6 = 3 , Group21Var9 = 4 , Group21Var10 = 5 } |
Static frozen counter variation More... | |
enum | StopBits { One = 0 , Two = 1 } |
Number of stop bits More... | |
enum | TaskError { TooManyRequests = 0 , BadResponse = 1 , ResponseTimeout = 2 , WriteError = 3 , NoConnection = 4 , Shutdown = 5 , AssociationRemoved = 6 } |
Task error used in IAssociationInformation More... | |
enum | TaskType { UserRead = 0 , PeriodicPoll = 1 , StartupIntegrity = 2 , AutoEventScan = 3 , Command = 4 , ClearRestartBit = 5 , EnableUnsolicited = 6 , DisableUnsolicited = 7 , TimeSync = 8 , Restart = 9 } |
Task type used in IAssociationInformation More... | |
enum | TimeFormat { None = 0 , Rfc3339 = 1 , System = 2 } |
Describes if and how the time will be formatted in log messages More... | |
enum | TimeQuality { SynchronizedTime = 0 , UnsynchronizedTime = 1 , InvalidTime = 2 } |
Timestamp quality More... | |
enum | TimeSyncError { Ok = 0 , ClockRollback = 1 , SystemTimeNotUnix = 2 , BadOutstationTimeDelay = 3 , Overflow = 4 , StillNeedsTime = 5 , SystemTimeNotAvailable = 6 , IinError = 7 , TooManyRequests = 8 , BadResponse = 9 , ResponseTimeout = 10 , WriteError = 11 , NoConnection = 12 , Shutdown = 13 , AssociationRemoved = 14 } |
Possible errors that can occur during a time synchronization procedure More... | |
enum | TimeSyncMode { Lan = 0 , NonLan = 1 } |
Time synchronization mode More... | |
enum | TransportDecodeLevel { Nothing = 0 , Header = 1 , Payload = 2 } |
Controls how transmitted and received transport segments are decoded at the INFO log level More... | |
enum | TripCloseCode { Nul = 0 , Close = 1 , Trip = 2 , Reserved = 3 } |
Trip-Close Code field, used in conjunction with OpType to specify a control operation More... | |
enum | Variation { Group1Var0 = 0 , Group1Var1 = 1 , Group1Var2 = 2 , Group2Var0 = 3 , Group2Var1 = 4 , Group2Var2 = 5 , Group2Var3 = 6 , Group3Var0 = 7 , Group3Var1 = 8 , Group3Var2 = 9 , Group4Var0 = 10 , Group4Var1 = 11 , Group4Var2 = 12 , Group4Var3 = 13 , Group10Var0 = 14 , Group10Var1 = 15 , Group10Var2 = 16 , Group11Var0 = 17 , Group11Var1 = 18 , Group11Var2 = 19 , Group12Var0 = 20 , Group12Var1 = 21 , Group20Var0 = 22 , Group20Var1 = 23 , Group20Var2 = 24 , Group20Var5 = 25 , Group20Var6 = 26 , Group21Var0 = 27 , Group21Var1 = 28 , Group21Var2 = 29 , Group21Var5 = 30 , Group21Var6 = 31 , Group21Var9 = 32 , Group21Var10 = 33 , Group22Var0 = 34 , Group22Var1 = 35 , Group22Var2 = 36 , Group22Var5 = 37 , Group22Var6 = 38 , Group23Var0 = 39 , Group23Var1 = 40 , Group23Var2 = 41 , Group23Var5 = 42 , Group23Var6 = 43 , Group30Var0 = 44 , Group30Var1 = 45 , Group30Var2 = 46 , Group30Var3 = 47 , Group30Var4 = 48 , Group30Var5 = 49 , Group30Var6 = 50 , Group32Var0 = 51 , Group32Var1 = 52 , Group32Var2 = 53 , Group32Var3 = 54 , Group32Var4 = 55 , Group32Var5 = 56 , Group32Var6 = 57 , Group32Var7 = 58 , Group32Var8 = 59 , Group40Var0 = 60 , Group40Var1 = 61 , Group40Var2 = 62 , Group40Var3 = 63 , Group40Var4 = 64 , Group41Var0 = 65 , Group41Var1 = 66 , Group41Var2 = 67 , Group41Var3 = 68 , Group41Var4 = 69 , Group42Var0 = 70 , Group42Var1 = 71 , Group42Var2 = 72 , Group42Var3 = 73 , Group42Var4 = 74 , Group42Var5 = 75 , Group42Var6 = 76 , Group42Var7 = 77 , Group42Var8 = 78 , Group50Var1 = 79 , Group50Var3 = 80 , Group50Var4 = 81 , Group51Var1 = 82 , Group51Var2 = 83 , Group52Var1 = 84 , Group52Var2 = 85 , Group60Var1 = 86 , Group60Var2 = 87 , Group60Var3 = 88 , Group60Var4 = 89 , Group80Var1 = 90 , Group110 = 91 , Group111 = 92 } |
Group/Variation More... | |
enum | WriteTimeResult { Ok = 0 , ParameterError = 1 , NotSupported = 2 } |
Write time result used by IOutstationApplication.WriteAbsoluteTime More... | |
enum dnp3.AppDecodeLevel |
enum dnp3.AutoTimeSync |
enum dnp3.BroadcastAction |
Enumeration describing how the outstation processed a broadcast request
enum dnp3.CertificateMode |
Determines how the certificate(s) presented by the peer are validated
This validation always occurs after the handshake signature has been verified.
enum dnp3.ClientState |
State of the client connection.
Use by the IClientStateListener.
enum dnp3.CommandError |
Result of a command
enum dnp3.CommandMode |
enum dnp3.CommandStatus |
Enumeration received from an outstation in response to command request
enum dnp3.ConnectionState |
enum dnp3.DataBits |
enum dnp3.DoubleBit |
Event analog variation
Event analog output status variation
enum dnp3.EventClass |
enum dnp3.EventMode |
enum dnp3.FlowControl |
enum dnp3.FreezeResult |
enum dnp3.FreezeType |
enum dnp3.FunctionCode |
Application layer function code
enum dnp3.LinkDecodeLevel |
enum dnp3.LinkErrorMode |
Controls how errors in parsed link-layer frames are handled. This behavior is configurable for physical layers with built-in error correction like TCP as the connection might be through a terminal server.
enum dnp3.LinkStatusError |
Errors that can occur during a manually initiated link status check. See MasterChannel.CheckLinkStatus
enum dnp3.LogLevel |
Log level
Used in ILogger.OnMessage callback to identify the log level of a message.
Enumerator | |
---|---|
Error | Error log level |
Warn | Warning log level |
Info | Information log level |
Debug | Debugging log level |
Trace | Trace log level |
enum dnp3.LogOutputFormat |
enum dnp3.MinTlsVersion |
enum dnp3.Nothing |
enum dnp3.OperateType |
enum dnp3.OpType |
Operation Type field, used in conjunction with TripCloseCode to specify a control operation
Enumerator | |
---|---|
Nul | NUL (0) |
PulseOn | PULSE_ON (1) |
PulseOff | PULSE_OFF (2) |
LatchOn | LATCH_ON (3) |
LatchOff | LATCH_OFF(4) |
enum dnp3.ParamError |
Error type used throughout the library
enum dnp3.Parity |
enum dnp3.PhysDecodeLevel |
enum dnp3.PortState |
enum dnp3.QualifierCode |
Qualifier code used in the response
enum dnp3.ReadError |
Errors that can occur during a read operation
enum dnp3.ReadType |
Type of restart delay value. Used by RestartDelay.
Enumerator | |
---|---|
NotSupported | Restart mode not supported |
Seconds | Value is in seconds (corresponds to g51v1) |
MilliSeconds | Value is in milliseconds (corresponds to g51v2) |
enum dnp3.RestartError |
Errors that can occur during a cold/warm restart operation
Static analog variation
Static analog output status variation
Static frozen counter variation
enum dnp3.StopBits |
enum dnp3.TaskError |
Task error used in IAssociationInformation
enum dnp3.TaskType |
Task type used in IAssociationInformation
enum dnp3.TimeFormat |
enum dnp3.TimeQuality |
enum dnp3.TimeSyncError |
Possible errors that can occur during a time synchronization procedure
enum dnp3.TimeSyncMode |
enum dnp3.TripCloseCode |
Trip-Close Code field, used in conjunction with OpType to specify a control operation
Enumerator | |
---|---|
Nul | NUL (0) |
Close | CLOSE (1) |
Trip | TRIP (2) |
Reserved | RESERVED (3) |
enum dnp3.Variation |
Group/Variation
enum dnp3.WriteTimeResult |
Write time result used by IOutstationApplication.WriteAbsoluteTime