FtpServer

Overview

FTPServer is the Internet Pack implementation of the FTP (File Transfer Protocol) for .NET.

Location

 

constructor

 

constructor

 

FtpServer()

 

init()

 

Sub New()

Active  virtual    (declared in Server)

Gets or sets the flag defining whether the server is listening for incoming connections.

Setting this property to true or false calls the Open or Close methods, accordingly

 

property Active: Boolean read write;

 

Boolean Active { get; set; }

 

var Active: Boolean { get{} set{} }

 

Property Active() As Boolean

AddCustomCommand  virtual    (declared in CommandBasedServer)

Add custom command to the server collection.

 

method AddCustomCommand(name: String; handler: OnCommandHandler)

 

void AddCustomCommand(String name, OnCommandHandler handler)

 

func AddCustomCommand(_ name: String, _ handler: OnCommandHandler)

 

Sub AddCustomCommand(name As String, handler As OnCommandHandler)

Parameters:

  • name:
  • handler:

AsciiEnter  virtual

The character (or characters) that represent the end-of-command sequence. Default is "\r\n" (char 13 and char 10). Some UNIX systems may only use char 10 when signifying the end of a line.

 

property AsciiEnter: String read write;

 

String AsciiEnter { get; set; }

 

var AsciiEnter: String { get{} set{} }

 

Property AsciiEnter() As String

BindAddressV4  virtual    (declared in Server)

 

property BindAddressV4: IPAddress read write;

 

IPAddress BindAddressV4 { get; set; }

 

var BindAddressV4: IPAddress { get{} set{} }

 

Property BindAddressV4() As IPAddress

BindAddressV6  virtual    (declared in Server)

 

property BindAddressV6: IPAddress read write;

 

IPAddress BindAddressV6 { get; set; }

 

var BindAddressV6: IPAddress { get{} set{} }

 

Property BindAddressV6() As IPAddress

Binding  virtual    (declared in Server)

Gets the ServerBinding instance.

In most cases, the IPv4 ServerBinding instance is returned. If the IPv4 protocol is not bound due to platform restictions, the IPv6 binding is returned.

 

property Binding: ServerBinding read;

 

ServerBinding Binding { get; }

 

var Binding: ServerBinding { get{} }

 

ReadOnly Property Binding() As ServerBinding

BindingV4  virtual    (declared in Server)

Gets the IPv4 ServerBinding instance.

The returned instance can be used to fine-tune the IPv4 server endpoint.

 

property BindingV4: ServerBinding read;

 

ServerBinding BindingV4 { get; }

 

var BindingV4: ServerBinding { get{} }

 

ReadOnly Property BindingV4() As ServerBinding

BindingV6  virtual    (declared in Server)

Gets the IPv6 ServerBinding instance.

The returned instance can be used to fine-tune the IPv6 server endpoint.

 

property BindingV6: ServerBinding read;

 

ServerBinding BindingV6 { get; }

 

var BindingV6: ServerBinding { get{} }

 

ReadOnly Property BindingV6() As ServerBinding

BindV4  virtual    (declared in Server)

Gets or sets the flag indicating whether the server should listen for IPv4 connections.

Setting this flag doesn't have any immediate effect. Its value is used only when the server is opened (either by setting the Active property to true or by directly calling the Open method).

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(true)]
property BindV4: Boolean read write;
// Island
property BindV4: Boolean read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(true)]
Boolean BindV4 { get; set; }
// Island
Boolean BindV4 { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(true)
var BindV4: Boolean { get{} set{} }
// Island, Toffee
var BindV4: Boolean { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(true)>
Property BindV4() As Boolean
// Island
Property BindV4() As Boolean

BindV6  virtual    (declared in Server)

Gets or sets the flag indicating whether the server should listen for IPv6 connections.

Setting this flag doesn't have any immediate effect. Its value is used only when the server is opened (either by setting the Active property to true or by directly calling the Open method).

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(true)]
property BindV6: Boolean read write;
// Island
property BindV6: Boolean read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(true)]
Boolean BindV6 { get; set; }
// Island
Boolean BindV6 { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(true)
var BindV6: Boolean { get{} set{} }
// Island, Toffee
var BindV6: Boolean { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(true)>
Property BindV6() As Boolean
// Island
Property BindV6() As Boolean

CleanStringForCommandResponse  protected virtual    (declared in CommandBasedServer)

 

class method CleanStringForCommandResponse(rawValue: String): String

 

static String CleanStringForCommandResponse(String rawValue)

 

static func CleanStringForCommandResponse(_ rawValue: String) -> String

 

Shared Function CleanStringForCommandResponse(rawValue As String) As String

Parameters:

  • rawValue:

Close  virtual    (declared in Server)

This method causes the server to stop listening for incoming connections.

 

method Close

 

void Close()

 

func Close()

 

Sub Close()

CloseConnectionsOnShutdown  virtual    (declared in Server)

Gets or sets the flag indicating whether the currently open client connections should be appropriately closed on server shutdown.

The default value is true.

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(true)]
property CloseConnectionsOnShutdown: Boolean read write;
// Island
property CloseConnectionsOnShutdown: Boolean read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(true)]
Boolean CloseConnectionsOnShutdown { get; set; }
// Island
Boolean CloseConnectionsOnShutdown { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(true)
var CloseConnectionsOnShutdown: Boolean { get{} set{} }
// Island, Toffee
var CloseConnectionsOnShutdown: Boolean { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(true)>
Property CloseConnectionsOnShutdown() As Boolean
// Island
Property CloseConnectionsOnShutdown() As Boolean

Cmd_ABOR  virtual

 

class method Cmd_ABOR(sender: Object; e: CommandEventArgs)

 

static void Cmd_ABOR(Object sender, CommandEventArgs e)

 

static func Cmd_ABOR(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_ABOR(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_ACCT  virtual

 

class method Cmd_ACCT(sender: Object; e: CommandEventArgs)

 

static void Cmd_ACCT(Object sender, CommandEventArgs e)

 

static func Cmd_ACCT(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_ACCT(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_APPE  virtual

 

class method Cmd_APPE(sender: Object; e: CommandEventArgs)

 

static void Cmd_APPE(Object sender, CommandEventArgs e)

 

static func Cmd_APPE(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_APPE(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_CDUP  virtual

 

class method Cmd_CDUP(sender: Object; e: CommandEventArgs)

 

static void Cmd_CDUP(Object sender, CommandEventArgs e)

 

static func Cmd_CDUP(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_CDUP(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_CWD  virtual

 

class method Cmd_CWD(sender: Object; e: CommandEventArgs)

 

static void Cmd_CWD(Object sender, CommandEventArgs e)

 

static func Cmd_CWD(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_CWD(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_DELE  virtual

 

class method Cmd_DELE(sender: Object; e: CommandEventArgs)

 

static void Cmd_DELE(Object sender, CommandEventArgs e)

 

static func Cmd_DELE(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_DELE(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_LIST  virtual

 

class method Cmd_LIST(sender: Object; e: CommandEventArgs)

 

static void Cmd_LIST(Object sender, CommandEventArgs e)

 

static func Cmd_LIST(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_LIST(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_MKD  virtual

 

class method Cmd_MKD(sender: Object; e: CommandEventArgs)

 

static void Cmd_MKD(Object sender, CommandEventArgs e)

 

static func Cmd_MKD(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_MKD(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_NOOP  virtual

 

class method Cmd_NOOP(sender: Object; e: CommandEventArgs)

 

static void Cmd_NOOP(Object sender, CommandEventArgs e)

 

static func Cmd_NOOP(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_NOOP(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_PASS  virtual

 

class method Cmd_PASS(sender: Object; e: CommandEventArgs)

 

static void Cmd_PASS(Object sender, CommandEventArgs e)

 

static func Cmd_PASS(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_PASS(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_PASV  virtual

 

class method Cmd_PASV(sender: Object; e: CommandEventArgs)

 

static void Cmd_PASV(Object sender, CommandEventArgs e)

 

static func Cmd_PASV(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_PASV(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_PORT  virtual

 

class method Cmd_PORT(sender: Object; e: CommandEventArgs)

 

static void Cmd_PORT(Object sender, CommandEventArgs e)

 

static func Cmd_PORT(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_PORT(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_PWD  virtual

 

class method Cmd_PWD(sender: Object; e: CommandEventArgs)

 

static void Cmd_PWD(Object sender, CommandEventArgs e)

 

static func Cmd_PWD(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_PWD(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_QUIT  virtual

 

class method Cmd_QUIT(sender: Object; e: CommandEventArgs)

 

static void Cmd_QUIT(Object sender, CommandEventArgs e)

 

static func Cmd_QUIT(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_QUIT(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_REST  virtual

 

class method Cmd_REST(sender: Object; e: CommandEventArgs)

 

static void Cmd_REST(Object sender, CommandEventArgs e)

 

static func Cmd_REST(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_REST(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_RETR  virtual

 

class method Cmd_RETR(sender: Object; e: CommandEventArgs)

 

static void Cmd_RETR(Object sender, CommandEventArgs e)

 

static func Cmd_RETR(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_RETR(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_RMD  virtual

 

class method Cmd_RMD(sender: Object; e: CommandEventArgs)

 

static void Cmd_RMD(Object sender, CommandEventArgs e)

 

static func Cmd_RMD(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_RMD(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_RNFR  virtual

 

class method Cmd_RNFR(sender: Object; e: CommandEventArgs)

 

static void Cmd_RNFR(Object sender, CommandEventArgs e)

 

static func Cmd_RNFR(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_RNFR(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_RNTO  virtual

 

class method Cmd_RNTO(sender: Object; e: CommandEventArgs)

 

static void Cmd_RNTO(Object sender, CommandEventArgs e)

 

static func Cmd_RNTO(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_RNTO(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_STOR  virtual

 

class method Cmd_STOR(sender: Object; e: CommandEventArgs)

 

static void Cmd_STOR(Object sender, CommandEventArgs e)

 

static func Cmd_STOR(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_STOR(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_SYST  virtual

 

class method Cmd_SYST(sender: Object; e: CommandEventArgs)

 

static void Cmd_SYST(Object sender, CommandEventArgs e)

 

static func Cmd_SYST(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_SYST(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_TYPE  virtual

 

class method Cmd_TYPE(sender: Object; e: CommandEventArgs)

 

static void Cmd_TYPE(Object sender, CommandEventArgs e)

 

static func Cmd_TYPE(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_TYPE(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_USER  virtual

 

class method Cmd_USER(sender: Object; e: CommandEventArgs)

 

static void Cmd_USER(Object sender, CommandEventArgs e)

 

static func Cmd_USER(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_USER(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Commands  virtual    (declared in CommandBasedServer)

 

property Commands: Dictionary<String, OnCommandHandler> read;

 

Dictionary<String, OnCommandHandler> Commands { get; }

 

var Commands: Dictionary<String, OnCommandHandler> { get{} }

 

ReadOnly Property Commands() As Dictionary<String, OnCommandHandler>

ConnectionClass    (declared in Server) .NET, .NET Core 5.0, .NET Standard 2.0

Gets or sets an alternative Connection class to be used for incoming data connections. The class described by the assigned Type must be a descendant of the Connection class, and will be used for all connections that are established after the property has been set.

Existing connections are not affected by changing the property.

If the ConnectionType property value is null (default), instances of the Connection base class will be used.

 

[DefaultValue(nil)]
property ConnectionClass: Type read write;

 

[DefaultValue(null)]
Type ConnectionClass { get; set; }

 

@DefaultValue(nil)
var ConnectionClass: Type { get{} set{} }

 

<DefaultValue(Null)>
Property ConnectionClass() As Type

ConnectionFactory  virtual    (declared in Server)

Gets or sets an alternative Connection factory instance to be used for incoming data connections. This factory will be used to create corresponding Connection instances for all connections that are established after the property has been set.

Existing connections are not affected by changing the property.

This property has precendence over the ConnectionClass property.

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(nil)]
property ConnectionFactory: IConnectionFactory read write;
// Island
property ConnectionFactory: IConnectionFactory read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(null)]
IConnectionFactory ConnectionFactory { get; set; }
// Island
IConnectionFactory ConnectionFactory { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(nil)
var ConnectionFactory: IConnectionFactory { get{} set{} }
// Island, Toffee
var ConnectionFactory: IConnectionFactory { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(Null)>
Property ConnectionFactory() As IConnectionFactory
// Island
Property ConnectionFactory() As IConnectionFactory

CreateSession  protected virtual    (declared in CommandBasedServer)

 

method CreateSession: CommandBasedSession

 

CommandBasedSession CreateSession()

 

func CreateSession() -> CommandBasedSession

 

Function CreateSession() As CommandBasedSession

DefaultPort  protected virtual    (declared in Server)

Gets or sets the default port number.

 

property DefaultPort: Int32 read write;

 

Int32 DefaultPort { get; set; }

 

var DefaultPort: Int32 { get{} set{} }

 

Property DefaultPort() As Int32

Detailed500Errors  virtual

If set to TRUE, FTPServer will return a standard #500 error message and the text of any exceptions raised. If set to FALSE, the server will only return a #500 error.

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(true)]
property Detailed500Errors: Boolean read write;
// Island
property Detailed500Errors: Boolean read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(true)]
Boolean Detailed500Errors { get; set; }
// Island
Boolean Detailed500Errors { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(true)
var Detailed500Errors: Boolean { get{} set{} }
// Island, Toffee
var Detailed500Errors: Boolean { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(true)>
Property Detailed500Errors() As Boolean
// Island
Property Detailed500Errors() As Boolean

Dispose  protected override    (declared in Server)

Disposes of the current instance and releases all resources used by it.

 

method Dispose(disposing: Boolean)

 

void Dispose(Boolean disposing)

 

func Dispose(_ disposing: Boolean)

 

Sub Dispose(disposing As Boolean)

Parameters:

  • disposing:

EnableNagle  virtual    (declared in Server)

Gets or the sets flag indicating whether the Nagle's algoritm should be used.

Setting this flag doesn't have any immediate effect. Its value is used only when the server is opened (either by setting the Active property to true or by directly calling the Open method).

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(false)]
property EnableNagle: Boolean read write;
// Island
property EnableNagle: Boolean read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(false)]
Boolean EnableNagle { get; set; }
// Island
Boolean EnableNagle { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(false)
var EnableNagle: Boolean { get{} set{} }
// Island, Toffee
var EnableNagle: Boolean { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(false)>
Property EnableNagle() As Boolean
// Island
Property EnableNagle() As Boolean

GetDefaultSessionClass  protected override

 

method GetDefaultSessionClass: Type

 

Type GetDefaultSessionClass()

 

func GetDefaultSessionClass() -> Type

 

Function GetDefaultSessionClass() As Type

GetWorkerClass  override    (declared in CommandBasedServer)

 

method GetWorkerClass: Type

 

Type GetWorkerClass()

 

func GetWorkerClass() -> Type

 

Function GetWorkerClass() As Type

Greeting  virtual    (declared in CommandBasedServer)

 

property Greeting: String read write;

 

String Greeting { get; set; }

 

var Greeting: String { get{} set{} }

 

Property Greeting() As String

HandleCommandException (Connection, Exception)  protected virtual    (declared in CommandBasedServer)

 

method HandleCommandException(connection: Connection; ex: Exception)

 

void HandleCommandException(Connection connection, Exception ex)

 

func HandleCommandException(_ connection: Connection, _ ex: Exception)

 

Sub HandleCommandException(connection As Connection, ex As Exception)

Parameters:

  • connection:
  • ex:

HandleCommandException (Connection, Exception)  protected override

 

method HandleCommandException(connection: Connection; exception: Exception)

 

void HandleCommandException(Connection connection, Exception exception)

 

func HandleCommandException(_ connection: Connection, _ exception: Exception)

 

Sub HandleCommandException(connection As Connection, exception As Exception)

Parameters:

  • connection:
  • exception:

InitCommands  protected override

 

method InitCommands

 

void InitCommands()

 

func InitCommands()

 

Sub InitCommands()

InvokeOnAccount  protected virtual

 

method InvokeOnAccount(e: FtpUserAccountArgs)

 

void InvokeOnAccount(FtpUserAccountArgs e)

 

func InvokeOnAccount(_ e: FtpUserAccountArgs)

 

Sub InvokeOnAccount(e As FtpUserAccountArgs)

Parameters:

  • e:

InvokeOnCanRetrieveFile  protected virtual

 

method InvokeOnCanRetrieveFile(e: FtpTransferEventArgs)

 

void InvokeOnCanRetrieveFile(FtpTransferEventArgs e)

 

func InvokeOnCanRetrieveFile(_ e: FtpTransferEventArgs)

 

Sub InvokeOnCanRetrieveFile(e As FtpTransferEventArgs)

Parameters:

  • e:

InvokeOnCanStoreFile  protected virtual

 

method InvokeOnCanStoreFile(e: FtpTransferEventArgs)

 

void InvokeOnCanStoreFile(FtpTransferEventArgs e)

 

func InvokeOnCanStoreFile(_ e: FtpTransferEventArgs)

 

Sub InvokeOnCanStoreFile(e As FtpTransferEventArgs)

Parameters:

  • e:

InvokeOnChangeDirectory  protected virtual

 

method InvokeOnChangeDirectory(e: FtpChangeDirectoryArgs)

 

void InvokeOnChangeDirectory(FtpChangeDirectoryArgs e)

 

func InvokeOnChangeDirectory(_ e: FtpChangeDirectoryArgs)

 

Sub InvokeOnChangeDirectory(e As FtpChangeDirectoryArgs)

Parameters:

  • e:

InvokeOnClientConnected  protected virtual    (declared in CommandBasedServer)

 

method InvokeOnClientConnected(e: SessionEventArgs)

 

void InvokeOnClientConnected(SessionEventArgs e)

 

func InvokeOnClientConnected(_ e: SessionEventArgs)

 

Sub InvokeOnClientConnected(e As SessionEventArgs)

Parameters:

  • e:

InvokeOnClientDisconnected  protected override

 

method InvokeOnClientDisconnected(e: SessionEventArgs)

 

void InvokeOnClientDisconnected(SessionEventArgs e)

 

func InvokeOnClientDisconnected(_ e: SessionEventArgs)

 

Sub InvokeOnClientDisconnected(e As SessionEventArgs)

Parameters:

  • e:

InvokeOnDelete  protected virtual

 

method InvokeOnDelete(e: FtpFileEventArgs)

 

void InvokeOnDelete(FtpFileEventArgs e)

 

func InvokeOnDelete(_ e: FtpFileEventArgs)

 

Sub InvokeOnDelete(e As FtpFileEventArgs)

Parameters:

  • e:

InvokeOnDeleteDirectory  protected virtual

 

method InvokeOnDeleteDirectory(e: FtpFileEventArgs)

 

void InvokeOnDeleteDirectory(FtpFileEventArgs e)

 

func InvokeOnDeleteDirectory(_ e: FtpFileEventArgs)

 

Sub InvokeOnDeleteDirectory(e As FtpFileEventArgs)

Parameters:

  • e:

InvokeOnGetListing  protected virtual

 

method InvokeOnGetListing(e: FtpGetListingArgs)

 

void InvokeOnGetListing(FtpGetListingArgs e)

 

func InvokeOnGetListing(_ e: FtpGetListingArgs)

 

Sub InvokeOnGetListing(e As FtpGetListingArgs)

Parameters:

  • e:

InvokeOnMakeDirectory  protected virtual

 

method InvokeOnMakeDirectory(e: FtpFileEventArgs)

 

void InvokeOnMakeDirectory(FtpFileEventArgs e)

 

func InvokeOnMakeDirectory(_ e: FtpFileEventArgs)

 

Sub InvokeOnMakeDirectory(e As FtpFileEventArgs)

Parameters:

  • e:

InvokeOnRename  protected virtual

 

method InvokeOnRename(e: FtpRenameEventArgs)

 

void InvokeOnRename(FtpRenameEventArgs e)

 

func InvokeOnRename(_ e: FtpRenameEventArgs)

 

Sub InvokeOnRename(e As FtpRenameEventArgs)

Parameters:

  • e:

InvokeOnRetrieveFile  protected virtual

 

method InvokeOnRetrieveFile(e: FtpTransferEventArgs)

 

void InvokeOnRetrieveFile(FtpTransferEventArgs e)

 

func InvokeOnRetrieveFile(_ e: FtpTransferEventArgs)

 

Sub InvokeOnRetrieveFile(e As FtpTransferEventArgs)

Parameters:

  • e:

InvokeOnStoreFile  protected virtual

 

method InvokeOnStoreFile(e: FtpTransferEventArgs)

 

void InvokeOnStoreFile(FtpTransferEventArgs e)

 

func InvokeOnStoreFile(_ e: FtpTransferEventArgs)

 

Sub InvokeOnStoreFile(e As FtpTransferEventArgs)

Parameters:

  • e:

InvokeOnUserLogin  protected virtual

 

method InvokeOnUserLogin(e: FtpUserLoginEventArgs)

 

void InvokeOnUserLogin(FtpUserLoginEventArgs e)

 

func InvokeOnUserLogin(_ e: FtpUserLoginEventArgs)

 

Sub InvokeOnUserLogin(e As FtpUserLoginEventArgs)

Parameters:

  • e:

MaxLineLength  virtual    (declared in Server)

Gets or sets the default MaxLineLength value for all newly created Connections.

See the desription of the Connection.MaxLineLength property for details.

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(4096)]
property MaxLineLength: Int32 read write;
// Island
property MaxLineLength: Int32 read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(4096)]
Int32 MaxLineLength { get; set; }
// Island
Int32 MaxLineLength { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(4096)
var MaxLineLength: Int32 { get{} set{} }
// Island, Toffee
var MaxLineLength: Int32 { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(4096)>
Property MaxLineLength() As Int32
// Island
Property MaxLineLength() As Int32

MaxLineLengthEnabled  virtual    (declared in Server)

Gets or sets the default MaxLineLengthEnabled value for all newly created Connections.

See the desription of the Connection.MaxLineLengthEnabled property for details.

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(true)]
property MaxLineLengthEnabled: Boolean read write;
// Island
property MaxLineLengthEnabled: Boolean read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(true)]
Boolean MaxLineLengthEnabled { get; set; }
// Island
Boolean MaxLineLengthEnabled { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(true)
var MaxLineLengthEnabled: Boolean { get{} set{} }
// Island, Toffee
var MaxLineLengthEnabled: Boolean { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(true)>
Property MaxLineLengthEnabled() As Boolean
// Island
Property MaxLineLengthEnabled() As Boolean

OnAccount

This event is fired when the server receives an ACCT command, which can be used to provide additional authentication on some servers.

 

event OnAccount: OnFtpUserAccountHandler
delegate:  method OnAccount(sender: Object; e: FtpUserAccountArgs)

 

delegate OnFtpUserAccountHandler OnAccount()
delegate:  void OnAccount(Object sender, FtpUserAccountArgs e)

 

__event OnFtpUserAccountHandler: OnAccount!
delegate:  func OnAccount(_ sender: Object, _ e: FtpUserAccountArgs)

 

Event OnAccount As OnFtpUserAccountHandler
delegate:  Sub OnAccount(sender As Object, e As FtpUserAccountArgs)

OnCanRetrieveFile

This event is fired when a request is made to retrieve a file (RETR). Your event code can either raise an exception or modify the FtpTransferEventArgs.Ok property to affect the success or failure of the request prior to actually sending the file (see RemObjects.InternetPack.Ftp.FtpTransferEventArgs, and the parent class FtpFileEventArgs - specifically RemObjects.InternetPack.Ftp.FtpFileEventArgs.Ok property).

 

event OnCanRetrieveFile: OnFtpTransferHandler
delegate:  method OnCanRetrieveFile(sender: Object; e: FtpTransferEventArgs)

 

delegate OnFtpTransferHandler OnCanRetrieveFile()
delegate:  void OnCanRetrieveFile(Object sender, FtpTransferEventArgs e)

 

__event OnFtpTransferHandler: OnCanRetrieveFile!
delegate:  func OnCanRetrieveFile(_ sender: Object, _ e: FtpTransferEventArgs)

 

Event OnCanRetrieveFile As OnFtpTransferHandler
delegate:  Sub OnCanRetrieveFile(sender As Object, e As FtpTransferEventArgs)

OnCanStoreFile

This event is fired when a request is made to store a file (STOR). Your event code can either raise an exception or modify the FtpTransferEventArgs.Ok property to affect the success or failure of the request prior to actually sending the file (see RemObjects.InternetPack.Ftp.FtpTransferEventArgs , and the parent class FtpFileEventArgs - specifically RemObjects.InternetPack.Ftp.FtpFileEventArgs.Ok property).

 

event OnCanStoreFile: OnFtpTransferHandler
delegate:  method OnCanStoreFile(sender: Object; e: FtpTransferEventArgs)

 

delegate OnFtpTransferHandler OnCanStoreFile()
delegate:  void OnCanStoreFile(Object sender, FtpTransferEventArgs e)

 

__event OnFtpTransferHandler: OnCanStoreFile!
delegate:  func OnCanStoreFile(_ sender: Object, _ e: FtpTransferEventArgs)

 

Event OnCanStoreFile As OnFtpTransferHandler
delegate:  Sub OnCanStoreFile(sender As Object, e As FtpTransferEventArgs)

OnChangeDirectory

This event is fired when a request is made to change directories (CWD). Your event code can either raise an exception or modify the FtpTransferEventArgs.Ok property to affect the success or failure of the request (see RemObjects.InternetPack.Ftp.FtpTransferEventArgs , and the parent class FtpFileEventArgs - specifically RemObjects.InternetPack.Ftp.FtpFileEventArgs.Ok property).

 

event OnChangeDirectory: OnFtpChangeDirectoryHandler
delegate:  method OnChangeDirectory(sender: Object; e: FtpChangeDirectoryArgs)

 

delegate OnFtpChangeDirectoryHandler OnChangeDirectory()
delegate:  void OnChangeDirectory(Object sender, FtpChangeDirectoryArgs e)

 

__event OnFtpChangeDirectoryHandler: OnChangeDirectory!
delegate:  func OnChangeDirectory(_ sender: Object, _ e: FtpChangeDirectoryArgs)

 

Event OnChangeDirectory As OnFtpChangeDirectoryHandler
delegate:  Sub OnChangeDirectory(sender As Object, e As FtpChangeDirectoryArgs)

OnClientConnected    (declared in CommandBasedServer)

This event is fired when client connects to the server.

 

event OnClientConnected: OnClientConnectedHandler
delegate:  method OnClientConnected(sender: Object; e: SessionEventArgs)

 

delegate OnClientConnectedHandler OnClientConnected()
delegate:  void OnClientConnected(Object sender, SessionEventArgs e)

 

__event OnClientConnectedHandler: OnClientConnected!
delegate:  func OnClientConnected(_ sender: Object, _ e: SessionEventArgs)

 

Event OnClientConnected As OnClientConnectedHandler
delegate:  Sub OnClientConnected(sender As Object, e As SessionEventArgs)

OnClientDisconnected    (declared in CommandBasedServer)

This event is fired when client disconnects from the server.

 

event OnClientDisconnected: OnClientDisconnectedHandler
delegate:  method OnClientDisconnected(sender: Object; e: SessionEventArgs)

 

delegate OnClientDisconnectedHandler OnClientDisconnected()
delegate:  void OnClientDisconnected(Object sender, SessionEventArgs e)

 

__event OnClientDisconnectedHandler: OnClientDisconnected!
delegate:  func OnClientDisconnected(_ sender: Object, _ e: SessionEventArgs)

 

Event OnClientDisconnected As OnClientDisconnectedHandler
delegate:  Sub OnClientDisconnected(sender As Object, e As SessionEventArgs)

OnDelete

This event is fired when a request is made to delete a file (DELE). Your event code can either raise an exception or modify the FtpTransferEventArgs.Ok property to affect the success or failure of the request (see RemObjects.InternetPack.Ftp.FtpTransferEventArgs , and the parent class FtpFileEventArgs - specifically RemObjects.InternetPack.Ftp.FtpFileEventArgs.Ok property).

 

event OnDelete: OnFtpFileHandler
delegate:  method OnDelete(sender: Object; e: FtpFileEventArgs)

 

delegate OnFtpFileHandler OnDelete()
delegate:  void OnDelete(Object sender, FtpFileEventArgs e)

 

__event OnFtpFileHandler: OnDelete!
delegate:  func OnDelete(_ sender: Object, _ e: FtpFileEventArgs)

 

Event OnDelete As OnFtpFileHandler
delegate:  Sub OnDelete(sender As Object, e As FtpFileEventArgs)

OnDeleteDirectory

This event is fired when a request is made to delete a directory (RMD), your event code can either raise an exception or modify the FtpTransferEventArgs.Ok property to affect the success or failure of the request. (see RemObjects.InternetPack.Ftp.FtpTransferEventArgs , and the parent class FtpFileEventArgs - specifically RemObjects.InternetPack.Ftp.FtpFileEventArgs.Ok property. )

 

event OnDeleteDirectory: OnFtpFileHandler
delegate:  method OnDeleteDirectory(sender: Object; e: FtpFileEventArgs)

 

delegate OnFtpFileHandler OnDeleteDirectory()
delegate:  void OnDeleteDirectory(Object sender, FtpFileEventArgs e)

 

__event OnFtpFileHandler: OnDeleteDirectory!
delegate:  func OnDeleteDirectory(_ sender: Object, _ e: FtpFileEventArgs)

 

Event OnDeleteDirectory As OnFtpFileHandler
delegate:  Sub OnDeleteDirectory(sender As Object, e As FtpFileEventArgs)

OnGetListing

This event is fired when a request is made to list the contents of a directory (LIST), your event code can either raise an exception or modify the FtpTransferEventArgs.Ok property to affect the success or failure of the request. (see RemObjects.InternetPack.Ftp.FtpTransferEventArgs , and the parent class FtpFileEventArgs - specifically RemObjects.InternetPack.Ftp.FtpFileEventArgs.Ok property. )

 

event OnGetListing: OnFtpGetListingHandler
delegate:  method OnGetListing(sender: Object; e: FtpGetListingArgs)

 

delegate OnFtpGetListingHandler OnGetListing()
delegate:  void OnGetListing(Object sender, FtpGetListingArgs e)

 

__event OnFtpGetListingHandler: OnGetListing!
delegate:  func OnGetListing(_ sender: Object, _ e: FtpGetListingArgs)

 

Event OnGetListing As OnFtpGetListingHandler
delegate:  Sub OnGetListing(sender As Object, e As FtpGetListingArgs)

OnMakeDirectory

This event is fired when a request is made to create a directory (MKD). Your event code can either raise an exception or modify the FtpTransferEventArgs.Ok property to affect the success or failure of the request (see RemObjects.InternetPack.Ftp.FtpTransferEventArgs , and the parent class FtpFileEventArgs - specifically RemObjects.InternetPack.Ftp.FtpFileEventArgs.Ok property).

 

event OnMakeDirectory: OnFtpFileHandler
delegate:  method OnMakeDirectory(sender: Object; e: FtpFileEventArgs)

 

delegate OnFtpFileHandler OnMakeDirectory()
delegate:  void OnMakeDirectory(Object sender, FtpFileEventArgs e)

 

__event OnFtpFileHandler: OnMakeDirectory!
delegate:  func OnMakeDirectory(_ sender: Object, _ e: FtpFileEventArgs)

 

Event OnMakeDirectory As OnFtpFileHandler
delegate:  Sub OnMakeDirectory(sender As Object, e As FtpFileEventArgs)

OnRename

This event is fired when a request is made to rename a file (RNTO). Your event code can either raise an exception or modify the FtpTransferEventArgs.Ok property to affect the success or failure of the request (see RemObjects.InternetPack.Ftp.FtpTransferEventArgs , and the parent class FtpFileEventArgs - specifically RemObjects.InternetPack.Ftp.FtpFileEventArgs.Ok property).

 

event OnRename: OnFtpRenameHandler
delegate:  method OnRename(sender: Object; e: FtpRenameEventArgs)

 

delegate OnFtpRenameHandler OnRename()
delegate:  void OnRename(Object sender, FtpRenameEventArgs e)

 

__event OnFtpRenameHandler: OnRename!
delegate:  func OnRename(_ sender: Object, _ e: FtpRenameEventArgs)

 

Event OnRename As OnFtpRenameHandler
delegate:  Sub OnRename(sender As Object, e As FtpRenameEventArgs)

OnRetrieveFile

This event is fired when a file has already been requested (RETR) and passed the FtpServer.OnCanRetrieveFile event. This can then be used to as a last check (ex: the file exists) before attempting to send the file. Your event code can either raise an exception or modify the FtpTransferEventArgs.Ok property to affect the success or failure of the request. (see RemObjects.InternetPack.Ftp.FtpTransferEventArgs , and the parent class FtpFileEventArgs - specifically RemObjects.InternetPack.Ftp.FtpFileEventArgs.Ok property. )

 

event OnRetrieveFile: OnFtpTransferHandler
delegate:  method OnRetrieveFile(sender: Object; e: FtpTransferEventArgs)

 

delegate OnFtpTransferHandler OnRetrieveFile()
delegate:  void OnRetrieveFile(Object sender, FtpTransferEventArgs e)

 

__event OnFtpTransferHandler: OnRetrieveFile!
delegate:  func OnRetrieveFile(_ sender: Object, _ e: FtpTransferEventArgs)

 

Event OnRetrieveFile As OnFtpTransferHandler
delegate:  Sub OnRetrieveFile(sender As Object, e As FtpTransferEventArgs)

OnStoreFile

This event is fired when a file has already been sent (STOR) and passed the FtpServer.OnCanStoreFile event. This event can then be used as a last check (ex: the directory exists) before attempting to save the file. Your event code can either raise an exception or modify the FtpTransferEventArgs.Ok property to affect the success or failure of the request (see RemObjects.InternetPack.Ftp.FtpTransferEventArgs , and the parent class FtpFileEventArgs - specifically RemObjects.InternetPack.Ftp.FtpFileEventArgs.Ok property).

 

event OnStoreFile: OnFtpTransferHandler
delegate:  method OnStoreFile(sender: Object; e: FtpTransferEventArgs)

 

delegate OnFtpTransferHandler OnStoreFile()
delegate:  void OnStoreFile(Object sender, FtpTransferEventArgs e)

 

__event OnFtpTransferHandler: OnStoreFile!
delegate:  func OnStoreFile(_ sender: Object, _ e: FtpTransferEventArgs)

 

Event OnStoreFile As OnFtpTransferHandler
delegate:  Sub OnStoreFile(sender As Object, e As FtpTransferEventArgs)

OnUserLogin

This event is fired when a request is made to login (PASS). Your event code can either raise an exception or modify the FtpTransferEventArgs.Ok property to affect the success or failure of the request (see RemObjects.InternetPack.Ftp.FtpTransferEventArgs , and the parent class FtpFileEventArgs - specifically RemObjects.InternetPack.Ftp.FtpFileEventArgs.Ok property).

 

event OnUserLogin: OnFtpUserLoginHandler
delegate:  method OnUserLogin(sender: Object; e: FtpUserLoginEventArgs)

 

delegate OnFtpUserLoginHandler OnUserLogin()
delegate:  void OnUserLogin(Object sender, FtpUserLoginEventArgs e)

 

__event OnFtpUserLoginHandler: OnUserLogin!
delegate:  func OnUserLogin(_ sender: Object, _ e: FtpUserLoginEventArgs)

 

Event OnUserLogin As OnFtpUserLoginHandler
delegate:  Sub OnUserLogin(sender As Object, e As FtpUserLoginEventArgs)

Open  virtual    (declared in Server)

This method causes the server to start listening for incoming connections.

 

method Open

 

void Open()

 

func Open()

 

Sub Open()

Port  virtual    (declared in Server)

Gets or sets the port number on which the server will listen.

 

property Port: Int32 read write;

 

Int32 Port { get; set; }

 

var Port: Int32 { get{} set{} }

 

Property Port() As Int32

QuitReply  virtual

The text of the message that was sent when logging off the FTP server. Default is "221 Bye"

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue('211 Bye')]
property QuitReply: String read write;
// Island
property QuitReply: String read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(\"211 Bye\")]
String QuitReply { get; set; }
// Island
String QuitReply { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(\"211 Bye\")
var QuitReply: String { get{} set{} }
// Island, Toffee
var QuitReply: String { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(\"211 Bye\")>
Property QuitReply() As String
// Island
Property QuitReply() As String

ServerName  virtual

Used to return the name of the server to the client; this is used to denote that the server is ready to begin processing requests. The default is "FTP Server Ready".

 

property ServerName: String read write;

 

String ServerName { get; set; }

 

var ServerName: String { get{} set{} }

 

Property ServerName() As String

SessionClass  virtual    (declared in CommandBasedServer)

Represents the session object.

 

property SessionClass: Type read write;

 

Type SessionClass { get; set; }

 

var SessionClass: Type { get{} set{} }

 

Property SessionClass() As Type

ShouldSerializePort  virtual    (declared in Server)

Returns true when the DefaultPort is not equal to the Port.

 

method ShouldSerializePort: Boolean

 

Boolean ShouldSerializePort()

 

func ShouldSerializePort() -> Boolean

 

Function ShouldSerializePort() As Boolean

SystemType  virtual

A text string used to denote the system type when clients connect or ask for more information. The default is "UNIX".

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue('UNIX')]
property SystemType: String read write;
// Island
property SystemType: String read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(\"UNIX\")]
String SystemType { get; set; }
// Island
String SystemType { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(\"UNIX\")
var SystemType: String { get{} set{} }
// Island, Toffee
var SystemType: String { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(\"UNIX\")>
Property SystemType() As String
// Island
Property SystemType() As String

Timeout  virtual    (declared in Server)

Gets or sets the default Timeout value for all newly created Connections.

See the desription of the Connection.Timeout property for details.

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(300)]
property Timeout: Int32 read write;
// Island
property Timeout: Int32 read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(300)]
Int32 Timeout { get; set; }
// Island
Int32 Timeout { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(300)
var Timeout: Int32 { get{} set{} }
// Island, Toffee
var Timeout: Int32 { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(300)>
Property Timeout() As Int32
// Island
Property Timeout() As Int32

TimeoutEnabled  virtual    (declared in Server)

Gets or sets the default TimeoutEnabled value for all newly created Connections.

See the desription of the Connection.TimeoutEnabled property for details.

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(true)]
property TimeoutEnabled: Boolean read write;
// Island
property TimeoutEnabled: Boolean read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(true)]
Boolean TimeoutEnabled { get; set; }
// Island
Boolean TimeoutEnabled { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(true)
var TimeoutEnabled: Boolean { get{} set{} }
// Island, Toffee
var TimeoutEnabled: Boolean { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(true)>
Property TimeoutEnabled() As Boolean
// Island
Property TimeoutEnabled() As Boolean

UnknownCommand  virtual    (declared in CommandBasedServer)

If server receives unknown command then this property will be used as error message to show user.

 

property UnknownCommand: String read write;

 

String UnknownCommand { get; set; }

 

var UnknownCommand: String { get{} set{} }

 

Property UnknownCommand() As String

ValidateDirectory  virtual

This method can analyze a directory name and determine if it contains any disallowed characters.

 

class method ValidateDirectory(value: String): String

 

static String ValidateDirectory(String value)

 

static func ValidateDirectory(_ value: String) -> String

 

Shared Function ValidateDirectory(value As String) As String

Parameters:

  • value:

ValidFilename  virtual

This method can analyze a filename and determine if it is valid and does not contain any disallowed characters.

 

class method ValidFilename(value: String): Boolean

 

static Boolean ValidFilename(String value)

 

static func ValidFilename(_ value: String) -> Boolean

 

Shared Function ValidFilename(value As String) As Boolean

Parameters:

  • value:

 

Active  virtual    (declared in Server)

Gets or sets the flag defining whether the server is listening for incoming connections.

Setting this property to true or false calls the Open or Close methods, accordingly

 

property Active: Boolean read write;

 

Boolean Active { get; set; }

 

var Active: Boolean { get{} set{} }

 

Property Active() As Boolean

AsciiEnter  virtual

The character (or characters) that represent the end-of-command sequence. Default is "\r\n" (char 13 and char 10). Some UNIX systems may only use char 10 when signifying the end of a line.

 

property AsciiEnter: String read write;

 

String AsciiEnter { get; set; }

 

var AsciiEnter: String { get{} set{} }

 

Property AsciiEnter() As String

BindAddressV4  virtual    (declared in Server)

 

property BindAddressV4: IPAddress read write;

 

IPAddress BindAddressV4 { get; set; }

 

var BindAddressV4: IPAddress { get{} set{} }

 

Property BindAddressV4() As IPAddress

BindAddressV6  virtual    (declared in Server)

 

property BindAddressV6: IPAddress read write;

 

IPAddress BindAddressV6 { get; set; }

 

var BindAddressV6: IPAddress { get{} set{} }

 

Property BindAddressV6() As IPAddress

Binding  virtual    (declared in Server)

Gets the ServerBinding instance.

In most cases, the IPv4 ServerBinding instance is returned. If the IPv4 protocol is not bound due to platform restictions, the IPv6 binding is returned.

 

property Binding: ServerBinding read;

 

ServerBinding Binding { get; }

 

var Binding: ServerBinding { get{} }

 

ReadOnly Property Binding() As ServerBinding

BindingV4  virtual    (declared in Server)

Gets the IPv4 ServerBinding instance.

The returned instance can be used to fine-tune the IPv4 server endpoint.

 

property BindingV4: ServerBinding read;

 

ServerBinding BindingV4 { get; }

 

var BindingV4: ServerBinding { get{} }

 

ReadOnly Property BindingV4() As ServerBinding

BindingV6  virtual    (declared in Server)

Gets the IPv6 ServerBinding instance.

The returned instance can be used to fine-tune the IPv6 server endpoint.

 

property BindingV6: ServerBinding read;

 

ServerBinding BindingV6 { get; }

 

var BindingV6: ServerBinding { get{} }

 

ReadOnly Property BindingV6() As ServerBinding

BindV4  virtual    (declared in Server)

Gets or sets the flag indicating whether the server should listen for IPv4 connections.

Setting this flag doesn't have any immediate effect. Its value is used only when the server is opened (either by setting the Active property to true or by directly calling the Open method).

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(true)]
property BindV4: Boolean read write;
// Island
property BindV4: Boolean read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(true)]
Boolean BindV4 { get; set; }
// Island
Boolean BindV4 { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(true)
var BindV4: Boolean { get{} set{} }
// Island, Toffee
var BindV4: Boolean { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(true)>
Property BindV4() As Boolean
// Island
Property BindV4() As Boolean

BindV6  virtual    (declared in Server)

Gets or sets the flag indicating whether the server should listen for IPv6 connections.

Setting this flag doesn't have any immediate effect. Its value is used only when the server is opened (either by setting the Active property to true or by directly calling the Open method).

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(true)]
property BindV6: Boolean read write;
// Island
property BindV6: Boolean read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(true)]
Boolean BindV6 { get; set; }
// Island
Boolean BindV6 { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(true)
var BindV6: Boolean { get{} set{} }
// Island, Toffee
var BindV6: Boolean { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(true)>
Property BindV6() As Boolean
// Island
Property BindV6() As Boolean

CloseConnectionsOnShutdown  virtual    (declared in Server)

Gets or sets the flag indicating whether the currently open client connections should be appropriately closed on server shutdown.

The default value is true.

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(true)]
property CloseConnectionsOnShutdown: Boolean read write;
// Island
property CloseConnectionsOnShutdown: Boolean read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(true)]
Boolean CloseConnectionsOnShutdown { get; set; }
// Island
Boolean CloseConnectionsOnShutdown { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(true)
var CloseConnectionsOnShutdown: Boolean { get{} set{} }
// Island, Toffee
var CloseConnectionsOnShutdown: Boolean { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(true)>
Property CloseConnectionsOnShutdown() As Boolean
// Island
Property CloseConnectionsOnShutdown() As Boolean

Commands  virtual    (declared in CommandBasedServer)

 

property Commands: Dictionary<String, OnCommandHandler> read;

 

Dictionary<String, OnCommandHandler> Commands { get; }

 

var Commands: Dictionary<String, OnCommandHandler> { get{} }

 

ReadOnly Property Commands() As Dictionary<String, OnCommandHandler>

ConnectionClass    (declared in Server) .NET, .NET Core 5.0, .NET Standard 2.0

Gets or sets an alternative Connection class to be used for incoming data connections. The class described by the assigned Type must be a descendant of the Connection class, and will be used for all connections that are established after the property has been set.

Existing connections are not affected by changing the property.

If the ConnectionType property value is null (default), instances of the Connection base class will be used.

 

[DefaultValue(nil)]
property ConnectionClass: Type read write;

 

[DefaultValue(null)]
Type ConnectionClass { get; set; }

 

@DefaultValue(nil)
var ConnectionClass: Type { get{} set{} }

 

<DefaultValue(Null)>
Property ConnectionClass() As Type

ConnectionFactory  virtual    (declared in Server)

Gets or sets an alternative Connection factory instance to be used for incoming data connections. This factory will be used to create corresponding Connection instances for all connections that are established after the property has been set.

Existing connections are not affected by changing the property.

This property has precendence over the ConnectionClass property.

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(nil)]
property ConnectionFactory: IConnectionFactory read write;
// Island
property ConnectionFactory: IConnectionFactory read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(null)]
IConnectionFactory ConnectionFactory { get; set; }
// Island
IConnectionFactory ConnectionFactory { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(nil)
var ConnectionFactory: IConnectionFactory { get{} set{} }
// Island, Toffee
var ConnectionFactory: IConnectionFactory { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(Null)>
Property ConnectionFactory() As IConnectionFactory
// Island
Property ConnectionFactory() As IConnectionFactory

DefaultPort  protected virtual    (declared in Server)

Gets or sets the default port number.

 

property DefaultPort: Int32 read write;

 

Int32 DefaultPort { get; set; }

 

var DefaultPort: Int32 { get{} set{} }

 

Property DefaultPort() As Int32

Detailed500Errors  virtual

If set to TRUE, FTPServer will return a standard #500 error message and the text of any exceptions raised. If set to FALSE, the server will only return a #500 error.

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(true)]
property Detailed500Errors: Boolean read write;
// Island
property Detailed500Errors: Boolean read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(true)]
Boolean Detailed500Errors { get; set; }
// Island
Boolean Detailed500Errors { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(true)
var Detailed500Errors: Boolean { get{} set{} }
// Island, Toffee
var Detailed500Errors: Boolean { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(true)>
Property Detailed500Errors() As Boolean
// Island
Property Detailed500Errors() As Boolean

EnableNagle  virtual    (declared in Server)

Gets or the sets flag indicating whether the Nagle's algoritm should be used.

Setting this flag doesn't have any immediate effect. Its value is used only when the server is opened (either by setting the Active property to true or by directly calling the Open method).

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(false)]
property EnableNagle: Boolean read write;
// Island
property EnableNagle: Boolean read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(false)]
Boolean EnableNagle { get; set; }
// Island
Boolean EnableNagle { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(false)
var EnableNagle: Boolean { get{} set{} }
// Island, Toffee
var EnableNagle: Boolean { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(false)>
Property EnableNagle() As Boolean
// Island
Property EnableNagle() As Boolean

Greeting  virtual    (declared in CommandBasedServer)

 

property Greeting: String read write;

 

String Greeting { get; set; }

 

var Greeting: String { get{} set{} }

 

Property Greeting() As String

MaxLineLength  virtual    (declared in Server)

Gets or sets the default MaxLineLength value for all newly created Connections.

See the desription of the Connection.MaxLineLength property for details.

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(4096)]
property MaxLineLength: Int32 read write;
// Island
property MaxLineLength: Int32 read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(4096)]
Int32 MaxLineLength { get; set; }
// Island
Int32 MaxLineLength { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(4096)
var MaxLineLength: Int32 { get{} set{} }
// Island, Toffee
var MaxLineLength: Int32 { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(4096)>
Property MaxLineLength() As Int32
// Island
Property MaxLineLength() As Int32

MaxLineLengthEnabled  virtual    (declared in Server)

Gets or sets the default MaxLineLengthEnabled value for all newly created Connections.

See the desription of the Connection.MaxLineLengthEnabled property for details.

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(true)]
property MaxLineLengthEnabled: Boolean read write;
// Island
property MaxLineLengthEnabled: Boolean read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(true)]
Boolean MaxLineLengthEnabled { get; set; }
// Island
Boolean MaxLineLengthEnabled { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(true)
var MaxLineLengthEnabled: Boolean { get{} set{} }
// Island, Toffee
var MaxLineLengthEnabled: Boolean { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(true)>
Property MaxLineLengthEnabled() As Boolean
// Island
Property MaxLineLengthEnabled() As Boolean

Port  virtual    (declared in Server)

Gets or sets the port number on which the server will listen.

 

property Port: Int32 read write;

 

Int32 Port { get; set; }

 

var Port: Int32 { get{} set{} }

 

Property Port() As Int32

QuitReply  virtual

The text of the message that was sent when logging off the FTP server. Default is "221 Bye"

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue('211 Bye')]
property QuitReply: String read write;
// Island
property QuitReply: String read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(\"211 Bye\")]
String QuitReply { get; set; }
// Island
String QuitReply { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(\"211 Bye\")
var QuitReply: String { get{} set{} }
// Island, Toffee
var QuitReply: String { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(\"211 Bye\")>
Property QuitReply() As String
// Island
Property QuitReply() As String

ServerName  virtual

Used to return the name of the server to the client; this is used to denote that the server is ready to begin processing requests. The default is "FTP Server Ready".

 

property ServerName: String read write;

 

String ServerName { get; set; }

 

var ServerName: String { get{} set{} }

 

Property ServerName() As String

SessionClass  virtual    (declared in CommandBasedServer)

Represents the session object.

 

property SessionClass: Type read write;

 

Type SessionClass { get; set; }

 

var SessionClass: Type { get{} set{} }

 

Property SessionClass() As Type

SystemType  virtual

A text string used to denote the system type when clients connect or ask for more information. The default is "UNIX".

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue('UNIX')]
property SystemType: String read write;
// Island
property SystemType: String read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(\"UNIX\")]
String SystemType { get; set; }
// Island
String SystemType { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(\"UNIX\")
var SystemType: String { get{} set{} }
// Island, Toffee
var SystemType: String { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(\"UNIX\")>
Property SystemType() As String
// Island
Property SystemType() As String

Timeout  virtual    (declared in Server)

Gets or sets the default Timeout value for all newly created Connections.

See the desription of the Connection.Timeout property for details.

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(300)]
property Timeout: Int32 read write;
// Island
property Timeout: Int32 read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(300)]
Int32 Timeout { get; set; }
// Island
Int32 Timeout { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(300)
var Timeout: Int32 { get{} set{} }
// Island, Toffee
var Timeout: Int32 { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(300)>
Property Timeout() As Int32
// Island
Property Timeout() As Int32

TimeoutEnabled  virtual    (declared in Server)

Gets or sets the default TimeoutEnabled value for all newly created Connections.

See the desription of the Connection.TimeoutEnabled property for details.

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(true)]
property TimeoutEnabled: Boolean read write;
// Island
property TimeoutEnabled: Boolean read write;

 

// .NET, .NET Core 5.0, .NET Standard 2.0
[DefaultValue(true)]
Boolean TimeoutEnabled { get; set; }
// Island
Boolean TimeoutEnabled { get; set; }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
@DefaultValue(true)
var TimeoutEnabled: Boolean { get{} set{} }
// Island, Toffee
var TimeoutEnabled: Boolean { get{} set{} }

 

// .NET, .NET Core 5.0, .NET Standard 2.0
<DefaultValue(true)>
Property TimeoutEnabled() As Boolean
// Island
Property TimeoutEnabled() As Boolean

UnknownCommand  virtual    (declared in CommandBasedServer)

If server receives unknown command then this property will be used as error message to show user.

 

property UnknownCommand: String read write;

 

String UnknownCommand { get; set; }

 

var UnknownCommand: String { get{} set{} }

 

Property UnknownCommand() As String

 

CleanStringForCommandResponse  protected virtual    (declared in CommandBasedServer)

 

class method CleanStringForCommandResponse(rawValue: String): String

 

static String CleanStringForCommandResponse(String rawValue)

 

static func CleanStringForCommandResponse(_ rawValue: String) -> String

 

Shared Function CleanStringForCommandResponse(rawValue As String) As String

Parameters:

  • rawValue:

Cmd_ABOR  virtual

 

class method Cmd_ABOR(sender: Object; e: CommandEventArgs)

 

static void Cmd_ABOR(Object sender, CommandEventArgs e)

 

static func Cmd_ABOR(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_ABOR(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_ACCT  virtual

 

class method Cmd_ACCT(sender: Object; e: CommandEventArgs)

 

static void Cmd_ACCT(Object sender, CommandEventArgs e)

 

static func Cmd_ACCT(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_ACCT(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_APPE  virtual

 

class method Cmd_APPE(sender: Object; e: CommandEventArgs)

 

static void Cmd_APPE(Object sender, CommandEventArgs e)

 

static func Cmd_APPE(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_APPE(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_CDUP  virtual

 

class method Cmd_CDUP(sender: Object; e: CommandEventArgs)

 

static void Cmd_CDUP(Object sender, CommandEventArgs e)

 

static func Cmd_CDUP(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_CDUP(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_CWD  virtual

 

class method Cmd_CWD(sender: Object; e: CommandEventArgs)

 

static void Cmd_CWD(Object sender, CommandEventArgs e)

 

static func Cmd_CWD(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_CWD(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_DELE  virtual

 

class method Cmd_DELE(sender: Object; e: CommandEventArgs)

 

static void Cmd_DELE(Object sender, CommandEventArgs e)

 

static func Cmd_DELE(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_DELE(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_LIST  virtual

 

class method Cmd_LIST(sender: Object; e: CommandEventArgs)

 

static void Cmd_LIST(Object sender, CommandEventArgs e)

 

static func Cmd_LIST(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_LIST(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_MKD  virtual

 

class method Cmd_MKD(sender: Object; e: CommandEventArgs)

 

static void Cmd_MKD(Object sender, CommandEventArgs e)

 

static func Cmd_MKD(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_MKD(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_NOOP  virtual

 

class method Cmd_NOOP(sender: Object; e: CommandEventArgs)

 

static void Cmd_NOOP(Object sender, CommandEventArgs e)

 

static func Cmd_NOOP(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_NOOP(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_PASS  virtual

 

class method Cmd_PASS(sender: Object; e: CommandEventArgs)

 

static void Cmd_PASS(Object sender, CommandEventArgs e)

 

static func Cmd_PASS(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_PASS(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_PASV  virtual

 

class method Cmd_PASV(sender: Object; e: CommandEventArgs)

 

static void Cmd_PASV(Object sender, CommandEventArgs e)

 

static func Cmd_PASV(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_PASV(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_PORT  virtual

 

class method Cmd_PORT(sender: Object; e: CommandEventArgs)

 

static void Cmd_PORT(Object sender, CommandEventArgs e)

 

static func Cmd_PORT(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_PORT(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_PWD  virtual

 

class method Cmd_PWD(sender: Object; e: CommandEventArgs)

 

static void Cmd_PWD(Object sender, CommandEventArgs e)

 

static func Cmd_PWD(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_PWD(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_QUIT  virtual

 

class method Cmd_QUIT(sender: Object; e: CommandEventArgs)

 

static void Cmd_QUIT(Object sender, CommandEventArgs e)

 

static func Cmd_QUIT(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_QUIT(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_REST  virtual

 

class method Cmd_REST(sender: Object; e: CommandEventArgs)

 

static void Cmd_REST(Object sender, CommandEventArgs e)

 

static func Cmd_REST(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_REST(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_RETR  virtual

 

class method Cmd_RETR(sender: Object; e: CommandEventArgs)

 

static void Cmd_RETR(Object sender, CommandEventArgs e)

 

static func Cmd_RETR(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_RETR(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_RMD  virtual

 

class method Cmd_RMD(sender: Object; e: CommandEventArgs)

 

static void Cmd_RMD(Object sender, CommandEventArgs e)

 

static func Cmd_RMD(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_RMD(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_RNFR  virtual

 

class method Cmd_RNFR(sender: Object; e: CommandEventArgs)

 

static void Cmd_RNFR(Object sender, CommandEventArgs e)

 

static func Cmd_RNFR(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_RNFR(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_RNTO  virtual

 

class method Cmd_RNTO(sender: Object; e: CommandEventArgs)

 

static void Cmd_RNTO(Object sender, CommandEventArgs e)

 

static func Cmd_RNTO(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_RNTO(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_STOR  virtual

 

class method Cmd_STOR(sender: Object; e: CommandEventArgs)

 

static void Cmd_STOR(Object sender, CommandEventArgs e)

 

static func Cmd_STOR(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_STOR(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_SYST  virtual

 

class method Cmd_SYST(sender: Object; e: CommandEventArgs)

 

static void Cmd_SYST(Object sender, CommandEventArgs e)

 

static func Cmd_SYST(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_SYST(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_TYPE  virtual

 

class method Cmd_TYPE(sender: Object; e: CommandEventArgs)

 

static void Cmd_TYPE(Object sender, CommandEventArgs e)

 

static func Cmd_TYPE(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_TYPE(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

Cmd_USER  virtual

 

class method Cmd_USER(sender: Object; e: CommandEventArgs)

 

static void Cmd_USER(Object sender, CommandEventArgs e)

 

static func Cmd_USER(_ sender: Object, _ e: CommandEventArgs)

 

Shared Sub Cmd_USER(sender As Object, e As CommandEventArgs)

Parameters:

  • sender:
  • e:

ValidateDirectory  virtual

This method can analyze a directory name and determine if it contains any disallowed characters.

 

class method ValidateDirectory(value: String): String

 

static String ValidateDirectory(String value)

 

static func ValidateDirectory(_ value: String) -> String

 

Shared Function ValidateDirectory(value As String) As String

Parameters:

  • value:

ValidFilename  virtual

This method can analyze a filename and determine if it is valid and does not contain any disallowed characters.

 

class method ValidFilename(value: String): Boolean

 

static Boolean ValidFilename(String value)

 

static func ValidFilename(_ value: String) -> Boolean

 

Shared Function ValidFilename(value As String) As Boolean

Parameters:

  • value:

 

constructor

 

constructor

 

FtpServer()

 

init()

 

Sub New()

AddCustomCommand  virtual    (declared in CommandBasedServer)

Add custom command to the server collection.

 

method AddCustomCommand(name: String; handler: OnCommandHandler)

 

void AddCustomCommand(String name, OnCommandHandler handler)

 

func AddCustomCommand(_ name: String, _ handler: OnCommandHandler)

 

Sub AddCustomCommand(name As String, handler As OnCommandHandler)

Parameters:

  • name:
  • handler:

Close  virtual    (declared in Server)

This method causes the server to stop listening for incoming connections.

 

method Close

 

void Close()

 

func Close()

 

Sub Close()

CreateSession  protected virtual    (declared in CommandBasedServer)

 

method CreateSession: CommandBasedSession

 

CommandBasedSession CreateSession()

 

func CreateSession() -> CommandBasedSession

 

Function CreateSession() As CommandBasedSession

Dispose  protected override    (declared in Server)

Disposes of the current instance and releases all resources used by it.

 

method Dispose(disposing: Boolean)

 

void Dispose(Boolean disposing)

 

func Dispose(_ disposing: Boolean)

 

Sub Dispose(disposing As Boolean)

Parameters:

  • disposing:

GetDefaultSessionClass  protected override

 

method GetDefaultSessionClass: Type

 

Type GetDefaultSessionClass()

 

func GetDefaultSessionClass() -> Type

 

Function GetDefaultSessionClass() As Type

GetWorkerClass  override    (declared in CommandBasedServer)

 

method GetWorkerClass: Type

 

Type GetWorkerClass()

 

func GetWorkerClass() -> Type

 

Function GetWorkerClass() As Type

HandleCommandException (Connection, Exception)  protected virtual    (declared in CommandBasedServer)

 

method HandleCommandException(connection: Connection; ex: Exception)

 

void HandleCommandException(Connection connection, Exception ex)

 

func HandleCommandException(_ connection: Connection, _ ex: Exception)

 

Sub HandleCommandException(connection As Connection, ex As Exception)

Parameters:

  • connection:
  • ex:

HandleCommandException (Connection, Exception)  protected override

 

method HandleCommandException(connection: Connection; exception: Exception)

 

void HandleCommandException(Connection connection, Exception exception)

 

func HandleCommandException(_ connection: Connection, _ exception: Exception)

 

Sub HandleCommandException(connection As Connection, exception As Exception)

Parameters:

  • connection:
  • exception:

InitCommands  protected override

 

method InitCommands

 

void InitCommands()

 

func InitCommands()

 

Sub InitCommands()

InvokeOnAccount  protected virtual

 

method InvokeOnAccount(e: FtpUserAccountArgs)

 

void InvokeOnAccount(FtpUserAccountArgs e)

 

func InvokeOnAccount(_ e: FtpUserAccountArgs)

 

Sub InvokeOnAccount(e As FtpUserAccountArgs)

Parameters:

  • e:

InvokeOnCanRetrieveFile  protected virtual

 

method InvokeOnCanRetrieveFile(e: FtpTransferEventArgs)

 

void InvokeOnCanRetrieveFile(FtpTransferEventArgs e)

 

func InvokeOnCanRetrieveFile(_ e: FtpTransferEventArgs)

 

Sub InvokeOnCanRetrieveFile(e As FtpTransferEventArgs)

Parameters:

  • e:

InvokeOnCanStoreFile  protected virtual

 

method InvokeOnCanStoreFile(e: FtpTransferEventArgs)

 

void InvokeOnCanStoreFile(FtpTransferEventArgs e)

 

func InvokeOnCanStoreFile(_ e: FtpTransferEventArgs)

 

Sub InvokeOnCanStoreFile(e As FtpTransferEventArgs)

Parameters:

  • e:

InvokeOnChangeDirectory  protected virtual

 

method InvokeOnChangeDirectory(e: FtpChangeDirectoryArgs)

 

void InvokeOnChangeDirectory(FtpChangeDirectoryArgs e)

 

func InvokeOnChangeDirectory(_ e: FtpChangeDirectoryArgs)

 

Sub InvokeOnChangeDirectory(e As FtpChangeDirectoryArgs)

Parameters:

  • e:

InvokeOnClientConnected  protected virtual    (declared in CommandBasedServer)

 

method InvokeOnClientConnected(e: SessionEventArgs)

 

void InvokeOnClientConnected(SessionEventArgs e)

 

func InvokeOnClientConnected(_ e: SessionEventArgs)

 

Sub InvokeOnClientConnected(e As SessionEventArgs)

Parameters:

  • e:

InvokeOnClientDisconnected  protected override

 

method InvokeOnClientDisconnected(e: SessionEventArgs)

 

void InvokeOnClientDisconnected(SessionEventArgs e)

 

func InvokeOnClientDisconnected(_ e: SessionEventArgs)

 

Sub InvokeOnClientDisconnected(e As SessionEventArgs)

Parameters:

  • e:

InvokeOnDelete  protected virtual

 

method InvokeOnDelete(e: FtpFileEventArgs)

 

void InvokeOnDelete(FtpFileEventArgs e)

 

func InvokeOnDelete(_ e: FtpFileEventArgs)

 

Sub InvokeOnDelete(e As FtpFileEventArgs)

Parameters:

  • e:

InvokeOnDeleteDirectory  protected virtual

 

method InvokeOnDeleteDirectory(e: FtpFileEventArgs)

 

void InvokeOnDeleteDirectory(FtpFileEventArgs e)

 

func InvokeOnDeleteDirectory(_ e: FtpFileEventArgs)

 

Sub InvokeOnDeleteDirectory(e As FtpFileEventArgs)

Parameters:

  • e:

InvokeOnGetListing  protected virtual

 

method InvokeOnGetListing(e: FtpGetListingArgs)

 

void InvokeOnGetListing(FtpGetListingArgs e)

 

func InvokeOnGetListing(_ e: FtpGetListingArgs)

 

Sub InvokeOnGetListing(e As FtpGetListingArgs)

Parameters:

  • e:

InvokeOnMakeDirectory  protected virtual

 

method InvokeOnMakeDirectory(e: FtpFileEventArgs)

 

void InvokeOnMakeDirectory(FtpFileEventArgs e)

 

func InvokeOnMakeDirectory(_ e: FtpFileEventArgs)

 

Sub InvokeOnMakeDirectory(e As FtpFileEventArgs)

Parameters:

  • e:

InvokeOnRename  protected virtual

 

method InvokeOnRename(e: FtpRenameEventArgs)

 

void InvokeOnRename(FtpRenameEventArgs e)

 

func InvokeOnRename(_ e: FtpRenameEventArgs)

 

Sub InvokeOnRename(e As FtpRenameEventArgs)

Parameters:

  • e:

InvokeOnRetrieveFile  protected virtual

 

method InvokeOnRetrieveFile(e: FtpTransferEventArgs)

 

void InvokeOnRetrieveFile(FtpTransferEventArgs e)

 

func InvokeOnRetrieveFile(_ e: FtpTransferEventArgs)

 

Sub InvokeOnRetrieveFile(e As FtpTransferEventArgs)

Parameters:

  • e:

InvokeOnStoreFile  protected virtual

 

method InvokeOnStoreFile(e: FtpTransferEventArgs)

 

void InvokeOnStoreFile(FtpTransferEventArgs e)

 

func InvokeOnStoreFile(_ e: FtpTransferEventArgs)

 

Sub InvokeOnStoreFile(e As FtpTransferEventArgs)

Parameters:

  • e:

InvokeOnUserLogin  protected virtual

 

method InvokeOnUserLogin(e: FtpUserLoginEventArgs)

 

void InvokeOnUserLogin(FtpUserLoginEventArgs e)

 

func InvokeOnUserLogin(_ e: FtpUserLoginEventArgs)

 

Sub InvokeOnUserLogin(e As FtpUserLoginEventArgs)

Parameters:

  • e:

Open  virtual    (declared in Server)

This method causes the server to start listening for incoming connections.

 

method Open

 

void Open()

 

func Open()

 

Sub Open()

ShouldSerializePort  virtual    (declared in Server)

Returns true when the DefaultPort is not equal to the Port.

 

method ShouldSerializePort: Boolean

 

Boolean ShouldSerializePort()

 

func ShouldSerializePort() -> Boolean

 

Function ShouldSerializePort() As Boolean

 

OnAccount

This event is fired when the server receives an ACCT command, which can be used to provide additional authentication on some servers.

 

event OnAccount: OnFtpUserAccountHandler
delegate:  method OnAccount(sender: Object; e: FtpUserAccountArgs)

 

delegate OnFtpUserAccountHandler OnAccount()
delegate:  void OnAccount(Object sender, FtpUserAccountArgs e)

 

__event OnFtpUserAccountHandler: OnAccount!
delegate:  func OnAccount(_ sender: Object, _ e: FtpUserAccountArgs)

 

Event OnAccount As OnFtpUserAccountHandler
delegate:  Sub OnAccount(sender As Object, e As FtpUserAccountArgs)

OnCanRetrieveFile

This event is fired when a request is made to retrieve a file (RETR). Your event code can either raise an exception or modify the FtpTransferEventArgs.Ok property to affect the success or failure of the request prior to actually sending the file (see RemObjects.InternetPack.Ftp.FtpTransferEventArgs, and the parent class FtpFileEventArgs - specifically RemObjects.InternetPack.Ftp.FtpFileEventArgs.Ok property).

 

event OnCanRetrieveFile: OnFtpTransferHandler
delegate:  method OnCanRetrieveFile(sender: Object; e: FtpTransferEventArgs)

 

delegate OnFtpTransferHandler OnCanRetrieveFile()
delegate:  void OnCanRetrieveFile(Object sender, FtpTransferEventArgs e)

 

__event OnFtpTransferHandler: OnCanRetrieveFile!
delegate:  func OnCanRetrieveFile(_ sender: Object, _ e: FtpTransferEventArgs)

 

Event OnCanRetrieveFile As OnFtpTransferHandler
delegate:  Sub OnCanRetrieveFile(sender As Object, e As FtpTransferEventArgs)

OnCanStoreFile

This event is fired when a request is made to store a file (STOR). Your event code can either raise an exception or modify the FtpTransferEventArgs.Ok property to affect the success or failure of the request prior to actually sending the file (see RemObjects.InternetPack.Ftp.FtpTransferEventArgs , and the parent class FtpFileEventArgs - specifically RemObjects.InternetPack.Ftp.FtpFileEventArgs.Ok property).

 

event OnCanStoreFile: OnFtpTransferHandler
delegate:  method OnCanStoreFile(sender: Object; e: FtpTransferEventArgs)

 

delegate OnFtpTransferHandler OnCanStoreFile()
delegate:  void OnCanStoreFile(Object sender, FtpTransferEventArgs e)

 

__event OnFtpTransferHandler: OnCanStoreFile!
delegate:  func OnCanStoreFile(_ sender: Object, _ e: FtpTransferEventArgs)

 

Event OnCanStoreFile As OnFtpTransferHandler
delegate:  Sub OnCanStoreFile(sender As Object, e As FtpTransferEventArgs)

OnChangeDirectory

This event is fired when a request is made to change directories (CWD). Your event code can either raise an exception or modify the FtpTransferEventArgs.Ok property to affect the success or failure of the request (see RemObjects.InternetPack.Ftp.FtpTransferEventArgs , and the parent class FtpFileEventArgs - specifically RemObjects.InternetPack.Ftp.FtpFileEventArgs.Ok property).

 

event OnChangeDirectory: OnFtpChangeDirectoryHandler
delegate:  method OnChangeDirectory(sender: Object; e: FtpChangeDirectoryArgs)

 

delegate OnFtpChangeDirectoryHandler OnChangeDirectory()
delegate:  void OnChangeDirectory(Object sender, FtpChangeDirectoryArgs e)

 

__event OnFtpChangeDirectoryHandler: OnChangeDirectory!
delegate:  func OnChangeDirectory(_ sender: Object, _ e: FtpChangeDirectoryArgs)

 

Event OnChangeDirectory As OnFtpChangeDirectoryHandler
delegate:  Sub OnChangeDirectory(sender As Object, e As FtpChangeDirectoryArgs)

OnClientConnected    (declared in CommandBasedServer)

This event is fired when client connects to the server.

 

event OnClientConnected: OnClientConnectedHandler
delegate:  method OnClientConnected(sender: Object; e: SessionEventArgs)

 

delegate OnClientConnectedHandler OnClientConnected()
delegate:  void OnClientConnected(Object sender, SessionEventArgs e)

 

__event OnClientConnectedHandler: OnClientConnected!
delegate:  func OnClientConnected(_ sender: Object, _ e: SessionEventArgs)

 

Event OnClientConnected As OnClientConnectedHandler
delegate:  Sub OnClientConnected(sender As Object, e As SessionEventArgs)

OnClientDisconnected    (declared in CommandBasedServer)

This event is fired when client disconnects from the server.

 

event OnClientDisconnected: OnClientDisconnectedHandler
delegate:  method OnClientDisconnected(sender: Object; e: SessionEventArgs)

 

delegate OnClientDisconnectedHandler OnClientDisconnected()
delegate:  void OnClientDisconnected(Object sender, SessionEventArgs e)

 

__event OnClientDisconnectedHandler: OnClientDisconnected!
delegate:  func OnClientDisconnected(_ sender: Object, _ e: SessionEventArgs)

 

Event OnClientDisconnected As OnClientDisconnectedHandler
delegate:  Sub OnClientDisconnected(sender As Object, e As SessionEventArgs)

OnDelete

This event is fired when a request is made to delete a file (DELE). Your event code can either raise an exception or modify the FtpTransferEventArgs.Ok property to affect the success or failure of the request (see RemObjects.InternetPack.Ftp.FtpTransferEventArgs , and the parent class FtpFileEventArgs - specifically RemObjects.InternetPack.Ftp.FtpFileEventArgs.Ok property).

 

event OnDelete: OnFtpFileHandler
delegate:  method OnDelete(sender: Object; e: FtpFileEventArgs)

 

delegate OnFtpFileHandler OnDelete()
delegate:  void OnDelete(Object sender, FtpFileEventArgs e)

 

__event OnFtpFileHandler: OnDelete!
delegate:  func OnDelete(_ sender: Object, _ e: FtpFileEventArgs)

 

Event OnDelete As OnFtpFileHandler
delegate:  Sub OnDelete(sender As Object, e As FtpFileEventArgs)

OnDeleteDirectory

This event is fired when a request is made to delete a directory (RMD), your event code can either raise an exception or modify the FtpTransferEventArgs.Ok property to affect the success or failure of the request. (see RemObjects.InternetPack.Ftp.FtpTransferEventArgs , and the parent class FtpFileEventArgs - specifically RemObjects.InternetPack.Ftp.FtpFileEventArgs.Ok property. )

 

event OnDeleteDirectory: OnFtpFileHandler
delegate:  method OnDeleteDirectory(sender: Object; e: FtpFileEventArgs)

 

delegate OnFtpFileHandler OnDeleteDirectory()
delegate:  void OnDeleteDirectory(Object sender, FtpFileEventArgs e)

 

__event OnFtpFileHandler: OnDeleteDirectory!
delegate:  func OnDeleteDirectory(_ sender: Object, _ e: FtpFileEventArgs)

 

Event OnDeleteDirectory As OnFtpFileHandler
delegate:  Sub OnDeleteDirectory(sender As Object, e As FtpFileEventArgs)

OnGetListing

This event is fired when a request is made to list the contents of a directory (LIST), your event code can either raise an exception or modify the FtpTransferEventArgs.Ok property to affect the success or failure of the request. (see RemObjects.InternetPack.Ftp.FtpTransferEventArgs , and the parent class FtpFileEventArgs - specifically RemObjects.InternetPack.Ftp.FtpFileEventArgs.Ok property. )

 

event OnGetListing: OnFtpGetListingHandler
delegate:  method OnGetListing(sender: Object; e: FtpGetListingArgs)

 

delegate OnFtpGetListingHandler OnGetListing()
delegate:  void OnGetListing(Object sender, FtpGetListingArgs e)

 

__event OnFtpGetListingHandler: OnGetListing!
delegate:  func OnGetListing(_ sender: Object, _ e: FtpGetListingArgs)

 

Event OnGetListing As OnFtpGetListingHandler
delegate:  Sub OnGetListing(sender As Object, e As FtpGetListingArgs)

OnMakeDirectory

This event is fired when a request is made to create a directory (MKD). Your event code can either raise an exception or modify the FtpTransferEventArgs.Ok property to affect the success or failure of the request (see RemObjects.InternetPack.Ftp.FtpTransferEventArgs , and the parent class FtpFileEventArgs - specifically RemObjects.InternetPack.Ftp.FtpFileEventArgs.Ok property).

 

event OnMakeDirectory: OnFtpFileHandler
delegate:  method OnMakeDirectory(sender: Object; e: FtpFileEventArgs)

 

delegate OnFtpFileHandler OnMakeDirectory()
delegate:  void OnMakeDirectory(Object sender, FtpFileEventArgs e)

 

__event OnFtpFileHandler: OnMakeDirectory!
delegate:  func OnMakeDirectory(_ sender: Object, _ e: FtpFileEventArgs)

 

Event OnMakeDirectory As OnFtpFileHandler
delegate:  Sub OnMakeDirectory(sender As Object, e As FtpFileEventArgs)

OnRename

This event is fired when a request is made to rename a file (RNTO). Your event code can either raise an exception or modify the FtpTransferEventArgs.Ok property to affect the success or failure of the request (see RemObjects.InternetPack.Ftp.FtpTransferEventArgs , and the parent class FtpFileEventArgs - specifically RemObjects.InternetPack.Ftp.FtpFileEventArgs.Ok property).

 

event OnRename: OnFtpRenameHandler
delegate:  method OnRename(sender: Object; e: FtpRenameEventArgs)

 

delegate OnFtpRenameHandler OnRename()
delegate:  void OnRename(Object sender, FtpRenameEventArgs e)

 

__event OnFtpRenameHandler: OnRename!
delegate:  func OnRename(_ sender: Object, _ e: FtpRenameEventArgs)

 

Event OnRename As OnFtpRenameHandler
delegate:  Sub OnRename(sender As Object, e As FtpRenameEventArgs)

OnRetrieveFile

This event is fired when a file has already been requested (RETR) and passed the FtpServer.OnCanRetrieveFile event. This can then be used to as a last check (ex: the file exists) before attempting to send the file. Your event code can either raise an exception or modify the FtpTransferEventArgs.Ok property to affect the success or failure of the request. (see RemObjects.InternetPack.Ftp.FtpTransferEventArgs , and the parent class FtpFileEventArgs - specifically RemObjects.InternetPack.Ftp.FtpFileEventArgs.Ok property. )

 

event OnRetrieveFile: OnFtpTransferHandler
delegate:  method OnRetrieveFile(sender: Object; e: FtpTransferEventArgs)

 

delegate OnFtpTransferHandler OnRetrieveFile()
delegate:  void OnRetrieveFile(Object sender, FtpTransferEventArgs e)

 

__event OnFtpTransferHandler: OnRetrieveFile!
delegate:  func OnRetrieveFile(_ sender: Object, _ e: FtpTransferEventArgs)

 

Event OnRetrieveFile As OnFtpTransferHandler
delegate:  Sub OnRetrieveFile(sender As Object, e As FtpTransferEventArgs)

OnStoreFile

This event is fired when a file has already been sent (STOR) and passed the FtpServer.OnCanStoreFile event. This event can then be used as a last check (ex: the directory exists) before attempting to save the file. Your event code can either raise an exception or modify the FtpTransferEventArgs.Ok property to affect the success or failure of the request (see RemObjects.InternetPack.Ftp.FtpTransferEventArgs , and the parent class FtpFileEventArgs - specifically RemObjects.InternetPack.Ftp.FtpFileEventArgs.Ok property).

 

event OnStoreFile: OnFtpTransferHandler
delegate:  method OnStoreFile(sender: Object; e: FtpTransferEventArgs)

 

delegate OnFtpTransferHandler OnStoreFile()
delegate:  void OnStoreFile(Object sender, FtpTransferEventArgs e)

 

__event OnFtpTransferHandler: OnStoreFile!
delegate:  func OnStoreFile(_ sender: Object, _ e: FtpTransferEventArgs)

 

Event OnStoreFile As OnFtpTransferHandler
delegate:  Sub OnStoreFile(sender As Object, e As FtpTransferEventArgs)

OnUserLogin

This event is fired when a request is made to login (PASS). Your event code can either raise an exception or modify the FtpTransferEventArgs.Ok property to affect the success or failure of the request (see RemObjects.InternetPack.Ftp.FtpTransferEventArgs , and the parent class FtpFileEventArgs - specifically RemObjects.InternetPack.Ftp.FtpFileEventArgs.Ok property).

 

event OnUserLogin: OnFtpUserLoginHandler
delegate:  method OnUserLogin(sender: Object; e: FtpUserLoginEventArgs)

 

delegate OnFtpUserLoginHandler OnUserLogin()
delegate:  void OnUserLogin(Object sender, FtpUserLoginEventArgs e)

 

__event OnFtpUserLoginHandler: OnUserLogin!
delegate:  func OnUserLogin(_ sender: Object, _ e: FtpUserLoginEventArgs)

 

Event OnUserLogin As OnFtpUserLoginHandler
delegate:  Sub OnUserLogin(sender As Object, e As FtpUserLoginEventArgs)