IPWorks EDI 2020 Node.js Edition

Questions / Feedback?

AcceptConnection Event

Fired when a client connects.

Syntax

oftpserver.on('AcceptConnection', [callback])

Callback

The 'callback' is called when the 'AcceptConnection' event is emited.

function(e){ }

The argument 'e' has the following properties:

e.connectionId
e.clientSSIDCode
e.clientPassword
e.clientVersion
e.serverVersion
e.accept
e.errorCode
e.errorDescription

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 class 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 Node.js Edition - Version 20.0 [Build 8203]