on_accept_connection Event

Fired when a client connects.

Syntax

class OFTPServerAcceptConnectionEventParams(object):
  @property
  def connection_id() -> int: ...
  @property
  def client_ssid_code() -> str: ...
  @property
  def client_password() -> str: ...
  @property
  def client_version() -> int: ...
  @property
  def server_version() -> int: ...
  @server_version.setter
  def server_version(value) -> None: ...
  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...
  @property
  def error_code() -> int: ...
  @error_code.setter
  def error_code(value) -> None: ...
  @property
  def error_description() -> str: ...
  @error_description.setter
  def error_description(value) -> None: ...

# In class OFTPServer:
@property
def on_accept_connection() -> Callable[[OFTPServerAcceptConnectionEventParams], None]: ...
@on_accept_connection.setter
def on_accept_connection(event_hook: Callable[[OFTPServerAcceptConnectionEventParams], None]) -> None: ...

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:

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:

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