Class FtpCommandHandler

The base class for all FTP command handlers.

Inheritance

Object

FtpCommandHandler

Implements

IFtpCommandHandler

IFtpCommandBase

IFeatureHost

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: FubarDev.FtpServer.CommandHandlers

Assembly: FubarDev.FtpServer.Commands.dll

Syntax

public abstract class FtpCommandHandler : IFtpCommandHandler, IFtpCommandBase, IFeatureHost

Constructors

| Improve this Doc View Source

FtpCommandHandler()

Initializes a new instance of the FtpCommandHandler class.

Declaration

protected FtpCommandHandler()

| Improve this Doc View Source

FtpCommandHandler(String, String[])

Initializes a new instance of the FtpCommandHandler class.

Declaration

[Obsolete("The mapping from name to command handler is created by using the FtpCommandHandlerAttribute.")]
protected FtpCommandHandler(string name, params string[] alternativeNames)

Parameters

Type	Name	Description
String	name	The command name.
String[]	alternativeNames	Alternative names.

Properties

| Improve this Doc View Source

CommandContext

Gets or sets the FTP command context.

Declaration

public FtpCommandHandlerContext CommandContext { get; set; }

Property Value

Type	Description
FtpCommandHandlerContext

| Improve this Doc View Source

Connection

Gets the connection this command was created for.

Declaration

protected IFtpConnection Connection { get; }

Property Value

Type	Description
IFtpConnection

| Improve this Doc View Source

Data

Gets the connection data.

Declaration

[Obsolete("Query the information using the Features property instead.")]
protected FtpConnectionData Data { get; }

Property Value

Type	Description
FtpConnectionData

| Improve this Doc View Source

FtpContext

Gets the connection this command was created for.

Declaration

protected FtpContext FtpContext { get; }

Property Value

Type	Description
FtpContext

| Improve this Doc View Source

IsAbortable

Declaration

[Obsolete("Information about an FTP command handler can be queried through the IFtpCommandHandlerProvider service.")]
public virtual bool IsAbortable { get; }

Property Value

Type	Description
Boolean

| Improve this Doc View Source

IsLoginRequired

Declaration

[Obsolete("Information about an FTP command handler can be queried through the IFtpCommandHandlerProvider service.")]
public virtual bool IsLoginRequired { get; }

Property Value

Type	Description
Boolean

| Improve this Doc View Source

Names

Declaration

[Obsolete("The mapping from name to command handler is created by using the FtpCommandHandlerAttribute.")]
public IReadOnlyCollection<string> Names { get; }

Property Value

Type	Description
IReadOnlyCollection<String>

| Improve this Doc View Source

ServerMessages

Gets the server messages to be returned.

Declaration

protected IFtpServerMessages ServerMessages { get; }

Property Value

Type	Description
IFtpServerMessages

Methods

| Improve this Doc View Source

GetExtensions()

Declaration

public virtual IEnumerable<IFtpCommandHandlerExtension> GetExtensions()

Returns

Type	Description
IEnumerable<IFtpCommandHandlerExtension>

| Improve this Doc View Source

GetSupportedFeatures(IFtpConnection)

Declaration

[Obsolete("FTP command handlers (and other types) are now annotated with attributes implementing IFeatureInfo.")]
public virtual IEnumerable<IFeatureInfo> GetSupportedFeatures(IFtpConnection connection)

Parameters

Type	Name	Description
IFtpConnection	connection

Returns

Type	Description
IEnumerable<IFeatureInfo>

| Improve this Doc View Source

Process(FtpCommand, CancellationToken)

Declaration

public abstract Task<IFtpResponse? > Process(FtpCommand command, CancellationToken cancellationToken)

Parameters

Type	Name	Description
FtpCommand	command
CancellationToken	cancellationToken

Returns

Type	Description
Task<Nullable<IFtpResponse>>

| Improve this Doc View Source

T(String)

Translates a message using the current catalog of the active connection.

Declaration

protected string T(string message)

Parameters

Type	Name	Description
String	message	The message to translate.

Returns

Type	Description
String	The translated message.

| Improve this Doc View Source

T(String, Nullable<Object>[])

Translates a message using the current catalog of the active connection.

Declaration

[StringFormatMethod("message")]
protected string T(string message, params object? [] args)

Parameters

Type	Name	Description
String	message	The message to translate.
Nullable<Object>[]	args	The format arguments.

Returns

Type	Description
String	The translated message.

Implements

IFtpCommandHandler

IFtpCommandBase

IFeatureHost