Indy 9 | Content | Index | Reference

TIdSSLSocket
Hierarchy, Properties, Methods, See Also, Unit: IdSSLOpenSSL
Implements a socket connection for the SSL transport protocol.

    TIdSSLSocket = class(TObject)

Unit
IdSSLOpenSSL
Description
TIdSSLSocket is a class that provides a socket implementation that supports the Secure Socket Layer transport protocol. TIdSSLSocket allows both client and server SSL connections using an SSL context, as well as support for session identifiers and X.509 certificate files.

TIdSSLSocket.Cipher
TIdSSLSocket

    property Cipher: TIdSSLCipher;

Description
Cipher

TIdSSLSocket.PeerCert
TIdSSLSocket
X.509 certificate for a peer on the SSL socket connection.

    property PeerCert: TIdX509;

Description
PeerCert is a read-only TIdX509 property that represents the X.509 certificate for a peer connection on the SSL socket.

TIdSSLSocket.Accept
TIdSSLSocket
Creates and binds a new SSL socket.

    procedure Accept(const pHandle: TIdStackSocketHandle; fSSLContext: TIdSSLContext);

Parameters
const pHandle: TIdStackSocketHandle
Socket handle binding used for the new SSL socket.
fSSLContext: TIdSSLContext
SSL context for the SSL socket.
Description
Accept is a procedure that initializes an SSL socket for the SSL context specified in fSSLContext, and binds the SSL socket using the socket handle in pHandle.

TIdSSLSocket.Connect
TIdSSLSocket
Creates and binds a new client SSL socket.

    procedure Connect(const pHandle: TIdStackSocketHandle; fSSLContext: TIdSSLContext);

Parameters
const pHandle: TIdStackSocketHandle
Socket handle binding for the SSL socket.
fSSLContext: TIdSSLContext
SSL context for the SSL socket.
Description
Connect is a procedure that initializes an SSL socket for the client SSL context specified in fSSLContext, and binds the SSL socket using the socket handle in pHandle.

TIdSSLSocket.Create
TIdSSLSocket
Constructor for the object instance.

    constructor Create(Parent: TObject);

Parameters
Parent: TObject
Owner of the object instance.
Description
Create is the constructor for the object instance. Create assigns the Parent for the SSL socket.

TIdSSLSocket.Destroy
TIdSSLSocket
Frees an object instance.

    destructor Destroy; override;

Description
Destroy is the destructor for the object instance. Destroy will shutdown the SSL socket prior to freeing and releasing the object instance. Destroy calls the inherited Destroy method.

TIdSSLSocket.GetSessionID
TIdSSLSocket
SSL session identifier for the SSL socket.

    function GetSessionID: TByteArray;

Description
GetSessionID is a TByteArray function that returns SSL session identifier for the SSL socket.

TIdSSLSocket.GetSessionIDAsString
TIdSSLSocket
SSL session identifier in hexadecimal form.

    function GetSessionIDAsString: String;

Description
GetSessionIDAsString is a String function that returns a string containing the hexadecimal representation of the SSL session identifier for the SSL socket.

TIdSSLSocket.Recv
TIdSSLSocket

    function Recv(var ABuf; ALen: integer): integer;

Description
Recv

TIdSSLSocket.Send
TIdSSLSocket

    function Send(var ABuf; ALen: integer): integer;

Description
Send

TIdSSLSocket.SetCipherList
TIdSSLSocket
SetCipherList is not currently implemented.

    procedure SetCipherList(CipherList: String);

Description
SetCipherList is not currently implemented.

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