AcceptConnection Event

Fired when a client connects.

Syntax

public event OnAcceptConnectionHandler OnAcceptConnection;

public delegate void OnAcceptConnectionHandler(object sender, OftpserverAcceptConnectionEventArgs e);

public class OftpserverAcceptConnectionEventArgs : EventArgs {
  public string ConnectionId { get; }
  public string ClientSSIDCode { get; }
  public string ClientPassword { get; }
  public int ClientVersion { get; }
  public int ServerVersion { get; set; }
  public bool Accept { get; set; }
  public int ErrorCode { get; set; }
  public string ErrorDescription { get; set; }
}
Public Event OnAcceptConnection As OnAcceptConnectionHandler

Public Delegate Sub OnAcceptConnectionHandler(sender As Object, e As OftpserverAcceptConnectionEventArgs)

Public Class OftpserverAcceptConnectionEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property ClientSSIDCode As String
  Public ReadOnly Property ClientPassword As String
  Public ReadOnly Property ClientVersion As Integer
  Public Property ServerVersion As Integer
  Public Property Accept As Boolean
  Public Property ErrorCode As Integer
  Public Property ErrorDescription As String
End Class

Remarks

This event fires when a new OFTP connection is made to the server. Use the parameters of this event to verify the identify of the client identified by the ConnectionId. By default the connection will be accepted. To reject the connection set Accept to false.

ClientVersion specifies the OFTP protocol version the client supports. By default the component will use the version requested by the client for the connection. If you wish to restrict connections to a specific OFTP protocol version use this value when determining whether or not to accept the connection. When rejecting the connection based on the OFTP protocol version use ErrorCode 10. Possible values are:

0 OFTP 1.2
1 OFTP 1.3
2 OFTP 1.4
3 OFTP 2.0

ServerVersion specifies the OFTP protocol version the server will use for the connection. By default this will be the same as ClientVersion. This may be set to a different version which will be sent back to the client. Possible values are:

0 OFTP 1.2
1 OFTP 1.3
2 OFTP 1.4
3 OFTP 2.0

When rejecting a connection the ErrorCode and ErrorDescription may optionally be set. Possible common values are:

ErrorCode ErrorDescription
3 User Code Not Known
4 Invalid Password
9 Unspecified Reason
10 Mode or capabilities incompatible
99 Unspecified Reason

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks EDI 2020 .NET Edition - Version 20.0 [Build 8203]