Interface IFtpServer

The interface that must be implemented by the FTP server.

Inherited Members

IPausableFtpService.Status

IPausableFtpService.PauseAsync(CancellationToken)

IPausableFtpService.ContinueAsync(CancellationToken)

IFtpService.StartAsync(CancellationToken)

IFtpService.StopAsync(CancellationToken)

Namespace: FubarDev.FtpServer

Assembly: FubarDev.FtpServer.Abstractions.dll

Syntax

public interface IFtpServer : IPausableFtpService, IFtpService

Properties

MaxActiveConnections

Gets the max allows active connections.

Declaration

int MaxActiveConnections { get; }

Property Value

Type	Description
Int32

Remarks

This will cause connections to be refused if count is exceeded. 0 (default) means no control over connection count.

Port

Gets the port on which the FTP server is listening for incoming connections.

Declaration

int Port { get; }

Property Value

Type	Description
Int32

Remarks

This value is only final after the ListenerStarted event was raised.

Ready

Gets a value indicating whether server ready to receive incoming connections.

Declaration

bool Ready { get; }

Property Value

Type	Description
Boolean

ServerAddress

Gets the public IP address (required for PASV and EPSV).

Declaration

string? ServerAddress { get; }

Property Value

Type	Description
Nullable<String>

Statistics

Gets the FTP server statistics.

Declaration

IFtpServerStatistics Statistics { get; }

Property Value

Type	Description
IFtpServerStatistics

Methods

Start()

Starts the FTP server in the background.

Declaration

[Obsolete("User IFtpServerHost.StartAsync instead.")]
void Start()

Stop()

Stops the FTP server.

Declaration

[Obsolete("User IFtpServerHost.StopAsync instead.")]
void Stop()

Remarks

The FTP server cannot be started again after it was stopped.

Events

ConfigureConnection

This event is raised when the connection is ready to be configured.

Declaration

event EventHandler<ConnectionEventArgs> ConfigureConnection

Event Type

Type	Description
EventHandler<ConnectionEventArgs>

ListenerStarted

This event is raised when the listener was started.

Declaration

event EventHandler<ListenerStartedEventArgs> ListenerStarted

Event Type

Type	Description
EventHandler<ListenerStartedEventArgs>