Indy 9 | Content | Index | Reference

TIdIdentServer
Hierarchy, Properties, Methods, Events, See Also, Unit: IdIdentServer
Implements a multi-threaded Identifcation Protocol server.

    TIdIdentServer = class(TIdTCPServer)

Unit
IdIdentServer
Description
TIdIdentServer is a TIdTCPServer descendant that implements a multi-threaded server for the Identifcation Protocol, as described in the Internet Standards document:

- RFC 1413 - Identification Protocol (http://www.rfc-editor.org/rfc/rfc1413.txt)

TIdIdentServer provides properties, methods, and events that can used, in conjunction with OnExecute, to implement the Identification Protocol which provides a means to determine the identity of a user of a particular TCP connection.

TIdIdentServer.DefaultPort
TIdIdentServer, See Also
Port number used to listen for client connections.

    property DefaultPort: integer;

Description
DefaultPort is an Integer property redefined in TIdIdentServer to reflect the port number used to listen for client connections in the Ident server, as required by the Ident protocol. DefaultPort is given the value IdPORT_AUTH in the Create constructor. DefaultPort is uised when constructing and binding the listener thread for the multi-threaded server implementation.

TIdIdentServer.QueryTimeOut
TIdIdentServer, See Also
Timeout value for connections to the Ident Server.

    property QueryTimeOut: Integer;

Description
QueryTimeOut is an Integer property that represents the time out value used for connections to the the Ident Server. If this value exceeded, the server will close the connection to the client. The default value is IdDefIdentQueryTimeOut, as assigned in the Create constructor.

TIdIdentServer.Create
TIdIdentServer, See Also
Constructor for the object instance.

    constructor Create(AOwner: TComponent); override;

Parameters
AOwner: TComponent
Owner of the object instance.
Description
Create is the constructor for the object instance. Create calls the inherited Create method using AOwner as the owner of the object instance. Create also assigns IdPORT_AUTH as the value for the DefaultPort property, as required by the Ident protocol. Create also sets QueryTimeOut to the default value IdDefIdentQueryTimeOut prior to exiting from the method.

TIdIdentServer.ReplyError
TIdIdentServer, See Also
This method sends an error reply to the client requesting a query.

    procedure ReplyError(AThread: TIdPeerThread; AServerPort: Integer; AClientPort: Integer; AErr: TIdIdentErrorType);

Parameters
AThread: TIdPeerThread
The connection thread for the query
AServerPort: Integer
The port that the connection on the server (the computer making the query)
AClientPort: Integer
The port that the client is connecting from (the port the daemon is using to connect to the server making the query)
AErr: TIdIdentErrorType
The error reply to send and it is one of the values in the TIdIdentErrorType topic
Description
This method sends an error reply to the client requesting a query.

TIdIdentServer.ReplyIdent
TIdIdentServer
This method sends the specified user name for a query.

    procedure ReplyIdent(AThread: TIdPeerThread; AServerPort: Integer; AClientPort: Integer; AOS: String; AUserName: String; const ACharset: String = '');

Parameters
AThread: TIdPeerThread
The connection thread for the query
AServerPort: Integer
The port that the connection on the server (the computer making the query)
AClientPort: Integer
The port that the client is connecting from (the port the daemon is using to connect to the server making the query)
AOS: String
This is the operating system that this computer is running. This value should be one of the Id_OS_ constants that is defined in the IdAssignedNumbers unit
AUserName: String
This is the user name to be sent to the client.
const ACharset: String = ''
This is the character set that the User name is in. This value should be one of the Id_CS constants that is defined in the IdAssignedNumber unit.

Description
This method sends the specified user name for a query.

TIdIdentServer.ReplyOther
TIdIdentServer
This method returns unformatted text to the client making a query.

    procedure ReplyOther(AThread: TIdPeerThread; AServerPort: Integer; AClientPort: Integer; AOther: String);

Parameters
AThread: TIdPeerThread
The connection thread for the query
AServerPort: Integer
The port that the connection on the server (the computer making the query)
AClientPort: Integer
The port that the client is connecting from (the port the daemon is using to connect to the server making the query)
AOther: String
This is the text that is sent to the client making the query.

Description
This method returns unformatted text to the client making a query. Examples include an encrypted audit token or other information about a user (such as the real name and phone number of a user from a UNIX passwd file)

TIdIdentServer.OnIdentQuery
TIdIdentServer
This event is triggered when a client queries this daemon.

    property OnIdentQuery: TIdIdentQueryEvent;

Parameters
AClientPort
The port that the client is connecting from (the port the daemon is using to connect to the server making the query)

AServerPort
The port that the connection on the server (the computer making the query)
AThread
The connection thread for the query. The event is triggered within the context of this thread
Description
This event is triggered when a client queries this daemon.

Created with Doc-O-Matic 2 donated to Project JEDI. Commercial license available from the Doc-O-Matic site.