CheckEngine Event

Fired to check engine parameters (timeliness, etc.).

Syntax

• C#
• VB.NET

public event OnCheckEngineHandler OnCheckEngine;

public delegate void OnCheckEngineHandler(object sender, SnmptcptrapmgrCheckEngineEventArgs e);

public class SnmptcptrapmgrCheckEngineEventArgs : EventArgs {
  public string EngineId { get; }
  public byte[] EngineIdB { get; }
  public int EngineBoots { get; }
  public int EngineTime { get; }
  public string User { get; }
  public int SecurityLevel { get; }
  public string RemoteAddress { get; }
  public int RemotePort { get; }
  public bool IsNew { get; }
  public bool Accept { get; set; }
}

Public Event OnCheckEngine As OnCheckEngineHandler

Public Delegate Sub OnCheckEngineHandler(sender As Object, e As SnmptcptrapmgrCheckEngineEventArgs)

Public Class SnmptcptrapmgrCheckEngineEventArgs Inherits EventArgs
  Public ReadOnly Property EngineId As String
  Public ReadOnly Property EngineIdB As Byte()
  Public ReadOnly Property EngineBoots As Integer
  Public ReadOnly Property EngineTime As Integer
  Public ReadOnly Property User As String
  Public ReadOnly Property SecurityLevel As Integer
  Public ReadOnly Property RemoteAddress As String
  Public ReadOnly Property RemotePort As Integer
  Public ReadOnly Property IsNew As Boolean
  Public Property Accept As Boolean
End Class

Remarks

The Accept parameter determines if the engine will be accepted or not. If you set Accept to False prior to exiting the event, the processing on the message will stop and a BadPacket event will be fired.

The default value of Accept is True if and only if:

a) the engine already exists in the internal authentication cache (the IsNew parameter is False) and the timeliness has been verified;

b) the engine does not exist in the internal authentication cache (the IsNew parameter is True), but the packet has been authenticated by the component (SecurityLevel >= 1).

In all other cases, the default value for Accept is False, and you are responsible for accepting or not accepting the engine based on other considerations.

If Accept is true upon event exit, then:

a) if the engine already exists in the internal authentication cache, its time is updated to reflect the new time and the processing of the packet continues;

b) if the engine does not exist in the internal authentication cache, it is added there and if User is authenticated, the User will be added too.