ChangeLog

Classes, Interfaces, Objects and Records

Types

Variables

Description

+Utilities for handling ASN.1 BER encoding

+ By this unit you can parse ASN.1 BER encoded data to elements or build back any elements to ASN.1 BER encoded buffer. You can dump ASN.1 BER encoded data to human readable form for easy debugging, too. + +

Supported element types are: ASN1_BOOL, ASN1_INT, ASN1_OCTSTR, ASN1_NULL, ASN1_OBJID, ASN1_ENUM, ASN1_SEQ, ASN1_SETOF, ASN1_IPADDR, ASN1_COUNTER, ASN1_GAUGE, ASN1_TIMETICKS, ASN1_OPAQUE + +

For sample of using, look to TSNMPSend or TLDAPSendclass.

uses

SysUtils
Classes
synautil

Overview

Functions and Procedures

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

function ASNEncOIDItem(Value: Integer): AnsiString;

function ASNDecOIDItem(var Start: Integer; const Buffer: AnsiString): Integer;

function ASNEncLen(Len: Integer): AnsiString;

function ASNDecLen(var Start: Integer; const Buffer: AnsiString): Integer;

function ASNEncInt(Value: Integer): AnsiString;

function ASNEncUInt(Value: Integer): AnsiString;

function ASNObject(const Data: AnsiString; ASNType: Integer): AnsiString;

function ASNItem(var Start: Integer; const Buffer: AnsiString; var ValueType: Integer): AnsiString;

function MibToId(Mib: String): AnsiString;

function IdToMib(const Id: AnsiString): String;

function IntMibToStr(const Value: AnsiString): AnsiString;

function ASNdump(const Value: AnsiString): AnsiString;

Constants

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

ASN1_BOOL = $01;

ASN1_INT = $02;

ASN1_OCTSTR = $04;

ASN1_NULL = $05;

ASN1_OBJID = $06;

ASN1_ENUM = $0a;

ASN1_SEQ = $30;

ASN1_SETOF = $31;

ASN1_IPADDR = $40;

ASN1_COUNTER = $41;

ASN1_GAUGE = $42;

ASN1_TIMETICKS = $43;

ASN1_OPAQUE = $44;

Description

Functions and Procedures

+ + + + +

function ASNEncOIDItem(Value: Integer): AnsiString;

+Encodes OID item to binary form.

+ + + + +

function ASNDecOIDItem(var Start: Integer; const Buffer: AnsiString): Integer;

+Decodes an OID item of the next element in the "Buffer" from the "Start" position.

+ + + + +

function ASNEncLen(Len: Integer): AnsiString;

+Encodes the length of ASN.1 element to binary.

+ + + + +

function ASNDecLen(var Start: Integer; const Buffer: AnsiString): Integer;

+Decodes length of next element in "Buffer" from the "Start" position.

+ + + + +

function ASNEncInt(Value: Integer): AnsiString;

+Encodes a signed integer to ASN.1 binary

+ + + + +

function ASNEncUInt(Value: Integer): AnsiString;

+Encodes unsigned integer into ASN.1 binary

+ + + + +

function ASNObject(const Data: AnsiString; ASNType: Integer): AnsiString;

+Encodes ASN.1 object to binary form.

+ + + + +

function ASNItem(var Start: Integer; const Buffer: AnsiString; var ValueType: Integer): AnsiString;

+Beginning with the "Start" position, decode the ASN.1 item of the next element in "Buffer". Type of item is stored in "ValueType."

+ + + + +

function MibToId(Mib: String): AnsiString;

+Encodes an MIB OID string to binary form.

+ + + + +

function IdToMib(const Id: AnsiString): String;

+Decodes MIB OID from binary form to string form.

+ + + + +

function IntMibToStr(const Value: AnsiString): AnsiString;

+Encodes an one number from MIB OID to binary form. (used internally from MibToId)

+ + + + +

function ASNdump(const Value: AnsiString): AnsiString;

+Convert ASN.1 BER encoded buffer to human readable form for debugging.

Constants

+ + + + +

ASN1_BOOL = $01;

+ + + + +

ASN1_INT = $02;

+ + + + +

ASN1_OCTSTR = $04;

+ + + + +

ASN1_NULL = $05;

+ + + + +

ASN1_OBJID = $06;

+ + + + +

ASN1_ENUM = $0a;

+ + + + +

ASN1_SEQ = $30;

+ + + + +

ASN1_SETOF = $31;

+ + + + +

ASN1_IPADDR = $40;

+ + + + +

ASN1_COUNTER = $41;

+ + + + +

ASN1_GAUGE = $42;

+ + + + +

ASN1_TIMETICKS = $43;

+ + + + +

ASN1_OPAQUE = $44;

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/automated.gif Index: lib/synapse/docs/help/automated.gif ================================================================== --- /dev/null +++ lib/synapse/docs/help/automated.gif cannot compute difference between binary files ADDED lib/synapse/docs/help/blcksock.ESynapseError.html Index: lib/synapse/docs/help/blcksock.ESynapseError.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/blcksock.ESynapseError.html @@ -0,0 +1,59 @@ + + + + + +blcksock: Class ESynapseError + + + +

Class ESynapseError

+ + +

Fields

Methods

Properties

Unit

Declaration

+type ESynapseError = class(Exception)

Description

+Exception clas used by Synapse

+ When you enable generating of exceptions, this exception is raised by Synapse's units.

Hierarchy

Exception
ESynapseError

Overview

Properties

+ + + + + + + + + +

	`property ErrorCode: Integer read FErrorCode Write FErrorCode;`
	`property ErrorMessage: string read FErrorMessage Write FErrorMessage;`

Description

Properties

+ + + + + +

property ErrorCode: Integer read FErrorCode Write FErrorCode;

+Code of error. Value depending on used operating system

+ + + + + +

property ErrorMessage: string read FErrorMessage Write FErrorMessage;

+Human readable description of error.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/blcksock.TBlockSocket.html Index: lib/synapse/docs/help/blcksock.TBlockSocket.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/blcksock.TBlockSocket.html @@ -0,0 +1,1307 @@ + + + + + +blcksock: Class TBlockSocket + + + +

Class TBlockSocket

+ + +

Fields

Unit

Declaration

+type TBlockSocket = class(TObject)

Description

+Basic IP object.

+ This is parent class for other class with protocol implementations. Do not use this class directly! Use TICMPBlockSocket, TRAWBlockSocket, TTCPBlockSocket or TUDPBlockSocket instead.

Hierarchy

TObject
TBlockSocket

Overview

Methods

	`constructor Create;`
	`constructor CreateAlternate(Stub: string);`
	`destructor Destroy; override;`
	`procedure CreateSocket;`
	`procedure CreateSocketByName(const Value: String);`
	`procedure CloseSocket; virtual;`
	`procedure AbortSocket; virtual;`
	`procedure Bind(IP, Port: string);`
	`procedure Connect(IP, Port: string); virtual;`
	`procedure Listen; virtual;`
	`function Accept: TSocket; virtual;`
	`function SendBuffer(Buffer: Tmemory; Length: Integer): Integer; virtual;`
	`procedure SendByte(Data: Byte); virtual;`
	`procedure SendString(Data: AnsiString); virtual;`
	`procedure SendInteger(Data: integer); virtual;`
	`procedure SendBlock(const Data: AnsiString); virtual;`
	`procedure SendStreamRaw(const Stream: TStream); virtual;`
	`procedure SendStream(const Stream: TStream); virtual;`
	`procedure SendStreamIndy(const Stream: TStream); virtual;`
	`function RecvBuffer(Buffer: TMemory; Length: Integer): Integer; virtual;`
	`function RecvBufferEx(Buffer: Tmemory; Len: Integer; Timeout: Integer): Integer; virtual;`
	`function RecvBufferStr(Len: Integer; Timeout: Integer): AnsiString; virtual;`
	`function RecvByte(Timeout: Integer): Byte; virtual;`
	`function RecvInteger(Timeout: Integer): Integer; virtual;`
	`function RecvString(Timeout: Integer): AnsiString; virtual;`
	`function RecvTerminated(Timeout: Integer; const Terminator: AnsiString): AnsiString; virtual;`
	`function RecvPacket(Timeout: Integer): AnsiString; virtual;`
	`function RecvBlock(Timeout: Integer): AnsiString; virtual;`
	`procedure RecvStreamRaw(const Stream: TStream; Timeout: Integer); virtual;`
	`procedure RecvStreamSize(const Stream: TStream; Timeout: Integer; Size: Integer);`
	`procedure RecvStream(const Stream: TStream; Timeout: Integer); virtual;`
	`procedure RecvStreamIndy(const Stream: TStream; Timeout: Integer); virtual;`
	`function PeekBuffer(Buffer: TMemory; Length: Integer): Integer; virtual;`
	`function PeekByte(Timeout: Integer): Byte; virtual;`
	`function WaitingData: Integer; virtual;`
	`function WaitingDataEx: Integer;`
	`procedure Purge;`
	`procedure SetLinger(Enable: Boolean; Linger: Integer);`
	`procedure GetSinLocal;`
	`procedure GetSinRemote;`
	`procedure GetSins;`
	`procedure ResetLastError;`
	`function SockCheck(SockResult: Integer): Integer; virtual;`
	`procedure ExceptCheck;`
	`function LocalName: string;`
	`procedure ResolveNameToIP(Name: string; const IPList: TStrings);`
	`function ResolveName(Name: string): string;`
	`function ResolveIPToName(IP: string): string;`
	`function ResolvePort(Port: string): Word;`
	`procedure SetRemoteSin(IP, Port: string);`
	`function GetLocalSinIP: string; virtual;`
	`function GetRemoteSinIP: string; virtual;`
	`function GetLocalSinPort: Integer; virtual;`
	`function GetRemoteSinPort: Integer; virtual;`
	`function CanRead(Timeout: Integer): Boolean; virtual;`
	`function CanReadEx(Timeout: Integer): Boolean; virtual;`
	`function CanWrite(Timeout: Integer): Boolean; virtual;`
	`function SendBufferTo(Buffer: TMemory; Length: Integer): Integer; virtual;`
	`function RecvBufferFrom(Buffer: TMemory; Length: Integer): Integer; virtual;`
	`function GroupCanRead(const SocketList: TList; Timeout: Integer; const CanReadList: TList): Boolean;`
	`procedure EnableReuse(Value: Boolean);`
	`procedure SetTimeout(Timeout: Integer);`
	`procedure SetSendTimeout(Timeout: Integer);`
	`procedure SetRecvTimeout(Timeout: Integer);`
	`function GetSocketType: integer; Virtual;`
	`function GetSocketProtocol: integer; Virtual;`
	`class function GetErrorDesc(ErrorCode: Integer): string;`
	`function GetErrorDescEx: string; virtual;`

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`property WSAData: TWSADATA read GetWsaData;`
	`property FDset: TFDSet read FFDset;`
	`property LocalSin: TVarSin read FLocalSin write FLocalSin;`
	`property RemoteSin: TVarSin read FRemoteSin write FRemoteSin;`
	`property Socket: TSocket read FSocket write SetSocket;`
	`property LastError: Integer read FLastError;`
	`property LastErrorDesc: string read FLastErrorDesc;`
	`property LineBuffer: AnsiString read FBuffer write FBuffer;`
	`property SizeRecvBuffer: Integer read GetSizeRecvBuffer write SetSizeRecvBuffer;`
	`property SizeSendBuffer: Integer read GetSizeSendBuffer write SetSizeSendBuffer;`
	`property NonBlockMode: Boolean read FNonBlockMode Write SetNonBlockMode;`
	`property TTL: Integer read GetTTL Write SetTTL;`
	`property IP6used: Boolean read FIP6used;`
	`property RecvCounter: Integer read FRecvCounter;`
	`property SendCounter: Integer read FSendCounter;`
	`property Tag: Integer read FTag write FTag;`
	`property RaiseExcept: Boolean read FRaiseExcept write FRaiseExcept;`
	`property MaxLineLength: Integer read FMaxLineLength Write FMaxLineLength;`
	`property MaxSendBandwidth: Integer read FMaxSendBandwidth Write FMaxSendBandwidth;`
	`property MaxRecvBandwidth: Integer read FMaxRecvBandwidth Write FMaxRecvBandwidth;`
	`property MaxBandwidth: Integer Write SetBandwidth;`
	`property ConvertLineEnd: Boolean read FConvertLineEnd Write FConvertLineEnd;`
	`property Family: TSocketFamily read FFamily Write SetFamily;`
	`property PreferIP4: Boolean read FPreferIP4 Write FPreferIP4;`
	`property InterPacketTimeout: Boolean read FInterPacketTimeout Write FInterPacketTimeout;`
	`property SendMaxChunk: Integer read FSendMaxChunk Write FSendMaxChunk;`
	`property StopFlag: Boolean read FStopFlag Write FStopFlag;`
	`property NonblockSendTimeout: Integer read FNonblockSendTimeout Write FNonblockSendTimeout;`
	`property OnStatus: THookSocketStatus read FOnStatus write FOnStatus;`
	`property OnReadFilter: THookDataFilter read FOnReadFilter write FOnReadFilter;`
	`property OnCreateSocket: THookCreateSocket read FOnCreateSocket write FOnCreateSocket;`
	`property OnMonitor: THookMonitor read FOnMonitor write FOnMonitor;`
	`property OnHeartbeat: THookHeartbeat read FOnHeartbeat write FOnHeartbeat;`
	`property HeartbeatRate: integer read FHeartbeatRate Write FHeartbeatRate;`
	`property Owner: TObject read FOwner Write FOwner;`

Description

Methods

+ + + + + +

constructor Create;

+ + + + + +

constructor CreateAlternate(Stub: string);

+Create object and load all necessary socket library. What library is loaded is described by STUB parameter. If STUB is empty string, then is loaded default libraries.

+ + + + + +

destructor Destroy; override;

+ + + + + +

procedure CreateSocket;

+If Family is not SF_Any, then create socket with type defined in Family property. If family is SF_Any, then do nothing! (socket is created automaticly when you know what type of socket you need to create. (i.e. inside Connect or Bind call.) When socket is created, then is aplyed all stored delayed socket options.

+ + + + + +

procedure CreateSocketByName(const Value: String);

+It create socket. Address resolving of Value tells what type of socket is created. If Value is resolved as IPv4 IP, then is created IPv4 socket. If value is resolved as IPv6 address, then is created IPv6 socket.

+ + + + + +

procedure CloseSocket; virtual;

+Destroy socket in use. This method is also automatically called from object destructor.

+ + + + + +

procedure AbortSocket; virtual;

+Abort any work on Socket and destroy them.

+ + + + + +

procedure Bind(IP, Port: string);

+Connects socket to local IP address and PORT. IP address may be numeric or symbolic ('192.168.74.50', 'cosi.nekde.cz', 'ff08::1'). The same for PORT - it may be number or mnemonic port ('23', 'telnet'). + +

If port value is '0', system chooses itself and conects unused port in the range 1024 to 4096 (this depending by operating system!). Structure LocalSin is filled after calling this method. + +

Note: If you call this on non-created socket, then socket is created automaticly. + +

Warning: when you call : Bind('0.0.0.0','0'); then is nothing done! In this case is used implicit system bind instead.

+ + + + + +

procedure Connect(IP, Port: string); virtual;

+Connects socket to remote IP address and PORT. The same rules as with Bind method are valid. The only exception is that PORT with 0 value will not be connected! + +

Structures LocalSin and RemoteSin will be filled with valid values. + +

+ + + + + +

procedure Listen; virtual;

+Sets socket to receive mode for new incoming connections. It is necessary to use TBlockSocket.Bind function call before this method to select receiving port!

+ + + + + +

function Accept: TSocket; virtual;

+Waits until new incoming connection comes. After it comes a new socket is automatically created (socket handler is returned by this function as result).

+ + + + + +

function SendBuffer(Buffer: Tmemory; Length: Integer): Integer; virtual;

+Sends data of LENGTH from BUFFER address via connected socket. System automatically splits data to packets.

+ + + + + +

procedure SendByte(Data: Byte); virtual;

+One data BYTE is sent via connected socket.

+ + + + + +

procedure SendString(Data: AnsiString); virtual;

+Send data string via connected socket. Any terminator is not added! If you need send true string with CR-LF termination, you must add CR-LF characters to sended string! Because any termination is not added automaticly, you can use this function for sending any binary data in binary string.

+ + + + + +

procedure SendInteger(Data: integer); virtual;

+Send integer as four bytes to socket.

+ + + + + +

procedure SendBlock(const Data: AnsiString); virtual;

+Send data as one block to socket. Each block begin with 4 bytes with length of data in block. This 4 bytes is added automaticly by this function.

+ + + + + +

procedure SendStreamRaw(const Stream: TStream); virtual;

+Send data from stream to socket.

+ + + + + +

procedure SendStream(const Stream: TStream); virtual;

+Send content of stream to socket. It using SendBlock method

+ + + + + +

procedure SendStreamIndy(const Stream: TStream); virtual;

+Send content of stream to socket. It using SendBlock method and this is compatible with streams in Indy library.

+ + + + + +

function RecvBuffer(Buffer: TMemory; Length: Integer): Integer; virtual;

+Note: This is low-level receive function. You must be sure if data is waiting for read before call this function for avoid deadlock! + +

Waits until allocated buffer is filled by received data. Returns number of data received, which equals to LENGTH value under normal operation. If it is not equal the communication channel is possibly broken. + +

On stream oriented sockets if is received 0 bytes, it mean 'socket is closed!" + +

On datagram socket is readed first waiting datagram.

+ + + + + +

function RecvBufferEx(Buffer: Tmemory; Len: Integer; Timeout: Integer): Integer; virtual;

+Note: This is high-level receive function. It using internal LineBuffer and you can combine this function freely with other high-level functions! + +

+ + + + + +

function RecvBufferStr(Len: Integer; Timeout: Integer): AnsiString; virtual;

+Similar to RecvBufferEx, but readed data is stored in binary string, not in memory buffer.

+ + + + + +

function RecvByte(Timeout: Integer): Byte; virtual;

+Note: This is high-level receive function. It using internal LineBuffer and you can combine this function freely with other high-level functions. + +

+ + + + + +

function RecvInteger(Timeout: Integer): Integer; virtual;

+Note: This is high-level receive function. It using internal LineBuffer and you can combine this function freely with other high-level functions. + +

Waits until one four bytes are received and return it as one Ineger Value. If no data is received within TIMEOUT (in milliseconds)period, LastError is set to WSAETIMEDOUT and result have value 0.

+ + + + + +

function RecvString(Timeout: Integer): AnsiString; virtual;

+Note: This is high-level receive function. It using internal LineBuffer and you can combine this function freely with other high-level functions. + +

+ + + + + +

function RecvTerminated(Timeout: Integer; const Terminator: AnsiString): AnsiString; virtual;

+Note: This is high-level receive function. It using internal LineBuffer and you can combine this function freely with other high-level functions. + +

+ + + + + +

function RecvPacket(Timeout: Integer): AnsiString; virtual;

+Note: This is high-level receive function. It using internal LineBuffer and you can combine this function freely with other high-level functions. + +

+ + + + + +

function RecvBlock(Timeout: Integer): AnsiString; virtual;

+Read one block of data from socket. Each block begin with 4 bytes with length of data in block. This function read first 4 bytes for get lenght, then it wait for reported count of bytes.

+ + + + + +

procedure RecvStreamRaw(const Stream: TStream; Timeout: Integer); virtual;

+Read all data from socket to stream until socket is closed (or any error occured.)

+ + + + + +

procedure RecvStreamSize(const Stream: TStream; Timeout: Integer; Size: Integer);

+Read requested count of bytes from socket to stream.

+ + + + + +

procedure RecvStream(const Stream: TStream; Timeout: Integer); virtual;

+Receive data to stream. It using RecvBlock method.

+ + + + + +

procedure RecvStreamIndy(const Stream: TStream; Timeout: Integer); virtual;

+Receive data to stream. This function is compatible with similar function in Indy library. It using RecvBlock method.

+ + + + + +

function PeekBuffer(Buffer: TMemory; Length: Integer): Integer; virtual;

+Same as RecvBuffer, but readed data stays in system input buffer. Warning: this function not respect data in LineBuffer! Is not recommended to use this function!

+ + + + + +

function PeekByte(Timeout: Integer): Byte; virtual;

+Same as RecvByte, but readed data stays in input system buffer. Warning: this function not respect data in LineBuffer! Is not recommended to use this function!

+ + + + + +

function WaitingData: Integer; virtual;

+On stream sockets it returns number of received bytes waiting for picking. 0 is returned when there is no such data. On datagram socket it returns length of the first waiting datagram. Returns 0 if no datagram is waiting.

+ + + + + +

function WaitingDataEx: Integer;

+Same as WaitingData, but if exists some of data in LineBuffer, return their length instead.

+ + + + + +

procedure Purge;

+Clear all waiting data for read from buffers.

+ + + + + +

procedure SetLinger(Enable: Boolean; Linger: Integer);

+Sets linger. Enabled linger means that the system waits another LINGER (in milliseconds) time for delivery of sent data. This function is only for stream type of socket! (TCP)

+ + + + + +

procedure GetSinLocal;

+Actualize values in LocalSin.

+ + + + + +

procedure GetSinRemote;

+Actualize values in RemoteSin.

+ + + + + +

procedure GetSins;

+Actualize values in LocalSin and RemoteSin.

+ + + + + +

procedure ResetLastError;

+Reset LastError and LastErrorDesc to non-error state.

+ + + + + +

function SockCheck(SockResult: Integer): Integer; virtual;

+If you "manually" call Socket API functions, forward their return code as parameter to this function, which evaluates it, eventually calls GetLastError and found error code returns and stores to LastError.

+ + + + + +

procedure ExceptCheck;

+If LastError contains some error code and RaiseExcept property is True, raise adequate exception.

+ + + + + +

function LocalName: string;

+Returns local computer name as numerical or symbolic value. It try get fully qualified domain name. Name is returned in the format acceptable by functions demanding IP as input parameter.

+ + + + + +

procedure ResolveNameToIP(Name: string; const IPList: TStrings);

+Try resolve name to all possible IP address. i.e. If you pass as name result of LocalName method, you get all IP addresses used by local system.

+ + + + + +

function ResolveName(Name: string): string;

+Try resolve name to primary IP address. i.e. If you pass as name result of LocalName method, you get primary IP addresses used by local system.

+ + + + + +

function ResolveIPToName(IP: string): string;

+Try resolve IP to their primary domain name. If IP not have domain name, then is returned original IP.

+ + + + + +

function ResolvePort(Port: string): Word;

+Try resolve symbolic port name to port number. (i.e. 'Echo' to 8)

+ + + + + +

procedure SetRemoteSin(IP, Port: string);

+Set information about remote side socket. It is good for seting remote side for sending UDP packet, etc.

+ + + + + +

function GetLocalSinIP: string; virtual;

+Picks IP socket address from LocalSin.

+ + + + + +

function GetRemoteSinIP: string; virtual;

+Picks IP socket address from RemoteSin.

+ + + + + +

function GetLocalSinPort: Integer; virtual;

+Picks socket PORT number from LocalSin.

+ + + + + +

function GetRemoteSinPort: Integer; virtual;

+Picks socket PORT number from RemoteSin.

+ + + + + +

function CanRead(Timeout: Integer): Boolean; virtual;

+Return True, if you can read any data from socket or is incoming connection on TCP based socket. Status is tested for time Timeout (in milliseconds). If value in Timeout is 0, status is only tested and continue. If value in Timeout is -1, run is breaked and waiting for read data maybe forever. + +

This function is need only on special cases, when you need use RecvBuffer function directly! read functioms what have timeout as calling parameter, calling this function internally.

+ + + + + +

function CanReadEx(Timeout: Integer): Boolean; virtual;

+Same as CanRead, but additionally return True if is some data in LineBuffer.

+ + + + + +

function CanWrite(Timeout: Integer): Boolean; virtual;

+Return True, if you can to socket write any data (not full sending buffer). Status is tested for time Timeout (in milliseconds). If value in Timeout is 0, status is only tested and continue. If value in Timeout is -1, run is breaked and waiting for write data maybe forever. + +

This function is need only on special cases!

+ + + + + +

function SendBufferTo(Buffer: TMemory; Length: Integer): Integer; virtual;

+Same as SendBuffer, but send datagram to address from RemoteSin. Usefull for sending reply to datagram received by function RecvBufferFrom.

+ + + + + +

function RecvBufferFrom(Buffer: TMemory; Length: Integer): Integer; virtual;

+Note: This is low-lever receive function. You must be sure if data is waiting for read before call this function for avoid deadlock! + +

+ + + + + +

function GroupCanRead(const SocketList: TList; Timeout: Integer; const CanReadList: TList): Boolean;

+This function is for check for incoming data on set of sockets. Whitch sockets is checked is decribed by SocketList Tlist with TBlockSocket objects. TList may have maximal number of objects defined by FD_SETSIZE constant. Return True, if you can from some socket read any data or is incoming connection on TCP based socket. Status is tested for time Timeout (in milliseconds). If value in Timeout is 0, status is only tested and continue. If value in Timeout is -1, run is breaked and waiting for read data maybe forever. If is returned True, CanReadList TList is filled by all TBlockSocket objects what waiting for read.

+ + + + + +

procedure EnableReuse(Value: Boolean);

+By this method you may turn address reuse mode for local Bind. It is good specially for UDP protocol. Using this with TCP protocol is hazardous!

+ + + + + +

procedure SetTimeout(Timeout: Integer);

+Try set timeout for all sending and receiving operations, if socket provider can do it. (It not supported by all socket providers!)

+ + + + + +

procedure SetSendTimeout(Timeout: Integer);

+Try set timeout for all sending operations, if socket provider can do it. (It not supported by all socket providers!)

+ + + + + +

procedure SetRecvTimeout(Timeout: Integer);

+Try set timeout for all receiving operations, if socket provider can do it. (It not supported by all socket providers!)

+ + + + + +

function GetSocketType: integer; Virtual;

+Return value of socket type.

+ + + + + +

function GetSocketProtocol: integer; Virtual;

+Return value of protocol type for socket creation.

+ + + + + +

class function GetErrorDesc(ErrorCode: Integer): string;

+Return descriptive string for given error code. This is class function. You may call it without created object!

+ + + + + +

function GetErrorDescEx: string; virtual;

+Return descriptive string for LastError.

Properties

+ + + + + +

property WSAData: TWSADATA read GetWsaData;

+WSA structure with information about socket provider. On non-windows platforms this structure is simulated!

+ + + + + +

property FDset: TFDSet read FFDset;

+FDset structure prepared for usage with this socket.

+ + + + + +

property LocalSin: TVarSin read FLocalSin write FLocalSin;

+Structure describing local socket side.

+ + + + + +

property RemoteSin: TVarSin read FRemoteSin write FRemoteSin;

+Structure describing remote socket side.

+ + + + + +

property Socket: TSocket read FSocket write SetSocket;

+Socket handler. Suitable for "manual" calls to socket API or manual connection of socket to a previously created socket (i.e by Accept method on TCP socket)

+ + + + + +

property LastError: Integer read FLastError;

+Last socket operation error code. Error codes are described in socket documentation. Human readable error description is stored in LastErrorDesc property.

+ + + + + +

property LastErrorDesc: string read FLastErrorDesc;

+Human readable error description of LastError code.

+ + + + + +

property LineBuffer: AnsiString read FBuffer write FBuffer;

+Buffer used by all high-level receiving functions. This buffer is used for optimized reading of data from socket. In normal cases you not need access to this buffer directly!

+ + + + + +

property SizeRecvBuffer: Integer read GetSizeRecvBuffer write SetSizeRecvBuffer;

+Size of Winsock receive buffer. If it is not supported by socket provider, it return as size one kilobyte.

+ + + + + +

property SizeSendBuffer: Integer read GetSizeSendBuffer write SetSizeSendBuffer;

+Size of Winsock send buffer. If it is not supported by socket provider, it return as size one kilobyte.

+ + + + + +

property NonBlockMode: Boolean read FNonBlockMode Write SetNonBlockMode;

+If True, turn class to non-blocking mode. Not all functions are working properly in this mode, you must know exactly what you are doing! However when you have big experience with non-blocking programming, then you can optimise your program by non-block mode!

+ + + + + +

property TTL: Integer read GetTTL Write SetTTL;

+Set Time-to-live value. (if system supporting it!)

+ + + + + +

property IP6used: Boolean read FIP6used;

+If is True, then class in in IPv6 mode.

+ + + + + +

property RecvCounter: Integer read FRecvCounter;

+Return count of received bytes on this socket from begin of current connection.

+ + + + + +

property SendCounter: Integer read FSendCounter;

+Return count of sended bytes on this socket from begin of current connection.

+ + + + + +

property Tag: Integer read FTag write FTag;

+this value is for free use.

+ + + + + +

property RaiseExcept: Boolean read FRaiseExcept write FRaiseExcept;

+If True, winsock errors raises exception. Otherwise is setted LastError value only and you must check it from your program! Default value is False.

+ + + + + +

property MaxLineLength: Integer read FMaxLineLength Write FMaxLineLength;

+Define maximum length in bytes of LineBuffer for high-level receiving functions. If this functions try to read more data then this limit, error is returned! If value is 0 (default), no limitation is used. This is very good protection for stupid attacks to your server by sending lot of data without proper terminator... until all your memory is allocated by LineBuffer! + +

Note: This maximum length is checked only in functions, what read unknown number of bytes! (like RecvString or RecvTerminated)

+ + + + + +

property MaxSendBandwidth: Integer read FMaxSendBandwidth Write FMaxSendBandwidth;

+Define maximal bandwidth for all sending operations in bytes per second. If value is 0 (default), bandwidth limitation is not used.

+ + + + + +

property MaxRecvBandwidth: Integer read FMaxRecvBandwidth Write FMaxRecvBandwidth;

+Define maximal bandwidth for all receiving operations in bytes per second. If value is 0 (default), bandwidth limitation is not used.

+ + + + + +

property MaxBandwidth: Integer Write SetBandwidth;

+Define maximal bandwidth for all sending and receiving operations in bytes per second. If value is 0 (default), bandwidth limitation is not used.

+ + + + + +

property ConvertLineEnd: Boolean read FConvertLineEnd Write FConvertLineEnd;

+Do a conversion of non-standard line terminators to CRLF. (Off by default) If True, then terminators like sigle CR, single LF or LFCR are converted to CRLF internally. This have effect only in RecvString method!

+ + + + + +

property Family: TSocketFamily read FFamily Write SetFamily;

+Specified Family of this socket. When you are using Windows preliminary support for IPv6, then I recommend to set this property!

+ + + + + +

property PreferIP4: Boolean read FPreferIP4 Write FPreferIP4;

+When resolving of domain name return both IPv4 and IPv6 addresses, then specify if is used IPv4 (dafault - True) or IPv6.

+ + + + + +

property InterPacketTimeout: Boolean read FInterPacketTimeout Write FInterPacketTimeout;

+By default (True) is all timeouts used as timeout between two packets in reading operations. If you set this to False, then Timeouts is for overall reading operation!

+ + + + + +

property SendMaxChunk: Integer read FSendMaxChunk Write FSendMaxChunk;

+All sended datas was splitted by this value.

+ + + + + +

property StopFlag: Boolean read FStopFlag Write FStopFlag;

+By setting this property to True you can stop any communication. You can use this property for soft abort of communication.

+ + + + + +

property NonblockSendTimeout: Integer read FNonblockSendTimeout Write FNonblockSendTimeout;

+Timeout for data sending by non-blocking socket mode.

+ + + + + +

property OnStatus: THookSocketStatus read FOnStatus write FOnStatus;

+This event is called by various reasons. It is good for monitoring socket, create gauges for data transfers, etc.

+ + + + + +

property OnReadFilter: THookDataFilter read FOnReadFilter write FOnReadFilter;

+this event is good for some internal thinks about filtering readed datas. It is used by telnet client by example.

+ + + + + +

property OnCreateSocket: THookCreateSocket read FOnCreateSocket write FOnCreateSocket;

+This event is called after real socket creation for setting special socket options, because you not know when socket is created. (it is depended on Ipv4, IPv6 or automatic mode)

+ + + + + +

property OnMonitor: THookMonitor read FOnMonitor write FOnMonitor;

+This event is good for monitoring content of readed or writed datas.

+ + + + + +

property OnHeartbeat: THookHeartbeat read FOnHeartbeat write FOnHeartbeat;

+This event is good for calling your code during long socket operations. (Example, for refresing UI if class in not called within the thread.) Rate of heartbeats can be modified by HeartbeatRate property.

+ + + + + +

property HeartbeatRate: integer read FHeartbeatRate Write FHeartbeatRate;

+Specify typical rate of OnHeartbeat event and StopFlag testing. Default value 0 disabling heartbeats! Value is in milliseconds. Real rate can be higher or smaller then this value, because it depending on real socket operations too! Note: Each heartbeat slowing socket processing.

+ + + + + +

property Owner: TObject read FOwner Write FOwner;

+What class own this socket? Used by protocol implementation classes.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/blcksock.TCustomSSL.html Index: lib/synapse/docs/help/blcksock.TCustomSSL.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/blcksock.TCustomSSL.html @@ -0,0 +1,633 @@ + + + + + +blcksock: Class TCustomSSL + + + +

Class TCustomSSL

+ + +

Fields

Unit

Declaration

+type TCustomSSL = class(TObject)

Description

+Parent class for all SSL plugins.

+ This is abstract class defining interface for other SSL plugins. + +

Instance of this class will be created for each TTCPBlockSocket. + +

Warning: not all methods and propertis can work in all existing SSL plugins! Please, read documentation of used SSL plugin.

Hierarchy

TObject
TCustomSSL

Overview

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`constructor Create(const Value: TTCPBlockSocket); virtual;`
	`procedure Assign(const Value: TCustomSSL); virtual;`
	`function LibVersion: String; virtual;`
	`function LibName: String; virtual;`
	`function Connect: boolean; virtual;`
	`function Accept: boolean; virtual;`
	`function Shutdown: boolean; virtual;`
	`function BiShutdown: boolean; virtual;`
	`function SendBuffer(Buffer: TMemory; Len: Integer): Integer; virtual;`
	`function RecvBuffer(Buffer: TMemory; Len: Integer): Integer; virtual;`
	`function WaitingData: Integer; virtual;`
	`function GetSSLVersion: string; virtual;`
	`function GetPeerSubject: string; virtual;`
	`function GetPeerSerialNo: integer; virtual;`
	`function GetPeerIssuer: string; virtual;`
	`function GetPeerName: string; virtual;`
	`function GetPeerNameHash: cardinal; virtual;`
	`function GetPeerFingerprint: string; virtual;`
	`function GetCertInfo: string; virtual;`
	`function GetCipherName: string; virtual;`
	`function GetCipherBits: integer; virtual;`
	`function GetCipherAlgBits: integer; virtual;`
	`function GetVerifyCert: integer; virtual;`

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`property SSLEnabled: Boolean read FSSLEnabled;`
	`property LastError: integer read FLastError;`
	`property LastErrorDesc: string read FLastErrorDesc;`
	`property SSLType: TSSLType read FSSLType write FSSLType;`
	`property KeyPassword: string read FKeyPassword write FKeyPassword;`
	`property Username: string read FUsername write FUsername;`
	`property Password: string read FPassword write FPassword;`
	`property Ciphers: string read FCiphers write FCiphers;`
	`property CertificateFile: string read FCertificateFile write FCertificateFile;`
	`property PrivateKeyFile: string read FPrivateKeyFile write FPrivateKeyFile;`
	`property Certificate: Ansistring read FCertificate write FCertificate;`
	`property PrivateKey: Ansistring read FPrivateKey write FPrivateKey;`
	`property PFX: Ansistring read FPFX write FPFX;`
	`property PFXfile: string read FPFXfile write FPFXfile;`
	`property TrustCertificateFile: string read FTrustCertificateFile write FTrustCertificateFile;`
	`property TrustCertificate: Ansistring read FTrustCertificate write FTrustCertificate;`
	`property CertCA: Ansistring read FCertCA write FCertCA;`
	`property CertCAFile: string read FCertCAFile write SetCertCAFile;`
	`property VerifyCert: Boolean read FVerifyCert write FVerifyCert;`
	`property SSHChannelType: string read FSSHChannelType write FSSHChannelType;`
	`property SSHChannelArg1: string read FSSHChannelArg1 write FSSHChannelArg1;`
	`property SSHChannelArg2: string read FSSHChannelArg2 write FSSHChannelArg2;`
	`property CertComplianceLevel: integer read FCertComplianceLevel write FCertComplianceLevel;`
	`property OnVerifyCert: THookVerifyCert read FOnVerifyCert write FOnVerifyCert;`
	`property SNIHost: string read FSNIHost write FSNIHost;`

Description

Methods

+ + + + + +

constructor Create(const Value: TTCPBlockSocket); virtual;

+Create plugin class. it is called internally from TTCPBlockSocket

+ + + + + +

procedure Assign(const Value: TCustomSSL); virtual;

+Assign settings (certificates and configuration) from another SSL plugin class.

+ + + + + +

function LibVersion: String; virtual;

+return description of used plugin. It usually return name and version of used SSL library.

+ + + + + +

function LibName: String; virtual;

+return name of used plugin.

+ + + + + +

function Connect: boolean; virtual;

+Do not call this directly. It is used internally by TTCPBlockSocket! + +

Here is needed code for start SSL connection.

+ + + + + +

function Accept: boolean; virtual;

+Do not call this directly. It is used internally by TTCPBlockSocket! + +

Here is needed code for acept new SSL connection.

+ + + + + +

function Shutdown: boolean; virtual;

+Do not call this directly. It is used internally by TTCPBlockSocket! + +

Here is needed code for hard shutdown of SSL connection. (for example, before socket is closed)

+ + + + + +

function BiShutdown: boolean; virtual;

+Do not call this directly. It is used internally by TTCPBlockSocket! + +

Here is needed code for soft shutdown of SSL connection. (for example, when you need to continue with unprotected connection.)

+ + + + + +

function SendBuffer(Buffer: TMemory; Len: Integer): Integer; virtual;

+Do not call this directly. It is used internally by TTCPBlockSocket! + +

Here is needed code for sending some datas by SSL connection.

+ + + + + +

function RecvBuffer(Buffer: TMemory; Len: Integer): Integer; virtual;

+Do not call this directly. It is used internally by TTCPBlockSocket! + +

Here is needed code for receiving some datas by SSL connection.

+ + + + + +

function WaitingData: Integer; virtual;

+Do not call this directly. It is used internally by TTCPBlockSocket! + +

Here is needed code for getting count of datas what waiting for read. If SSL plugin not allows this, then it should return 0.

+ + + + + +

function GetSSLVersion: string; virtual;

+Return string with identificator of SSL/TLS version of existing connection.

+ + + + + +

function GetPeerSubject: string; virtual;

+Return subject of remote SSL peer.

+ + + + + +

function GetPeerSerialNo: integer; virtual;

+Return Serial number if remote X509 certificate.

+ + + + + +

function GetPeerIssuer: string; virtual;

+Return issuer certificate of remote SSL peer.

+ + + + + +

function GetPeerName: string; virtual;

+Return peer name from remote side certificate. This is good for verify, if certificate is generated for remote side IP name.

+ + + + + +

function GetPeerNameHash: cardinal; virtual;

+Returns has of peer name from remote side certificate. This is good for fast remote side authentication.

+ + + + + +

function GetPeerFingerprint: string; virtual;

+Return fingerprint of remote SSL peer.

+ + + + + +

function GetCertInfo: string; virtual;

+Return all detailed information about certificate from remote side of SSL/TLS connection. Result string can be multilined! Each plugin can return this informations in different format!

+ + + + + +

function GetCipherName: string; virtual;

+Return currently used Cipher.

+ + + + + +

function GetCipherBits: integer; virtual;

+Return currently used number of bits in current Cipher algorythm.

+ + + + + +

function GetCipherAlgBits: integer; virtual;

+Return number of bits in current Cipher algorythm.

+ + + + + +

function GetVerifyCert: integer; virtual;

+Return result value of verify remote side certificate. Look to OpenSSL documentation for possible values. For example 0 is successfuly verified certificate, or 18 is self-signed certificate.

Properties

+ + + + + +

property SSLEnabled: Boolean read FSSLEnabled;

+Resurn True if SSL mode is enabled on existing cvonnection.

+ + + + + +

property LastError: integer read FLastError;

+Return error code of last SSL operation. 0 is OK.

+ + + + + +

property LastErrorDesc: string read FLastErrorDesc;

+Return error description of last SSL operation.

+ + + + + +

property SSLType: TSSLType read FSSLType write FSSLType;

+Here you can specify requested SSL/TLS mode. Default is autodetection, but on some servers autodetection not working properly. In this case you must specify requested SSL/TLS mode by your hand!

+ + + + + +

property KeyPassword: string read FKeyPassword write FKeyPassword;

+Password for decrypting of encoded certificate or key.

+ + + + + +

property Username: string read FUsername write FUsername;

+Username for possible credentials.

+ + + + + +

property Password: string read FPassword write FPassword;

+password for possible credentials.

+ + + + + +

property Ciphers: string read FCiphers write FCiphers;

+By this property you can modify default set of SSL/TLS ciphers.

+ + + + + +

property CertificateFile: string read FCertificateFile write FCertificateFile;

+Used for loading certificate from disk file. See to plugin documentation if this method is supported and how!

+ + + + + +

property PrivateKeyFile: string read FPrivateKeyFile write FPrivateKeyFile;

+Used for loading private key from disk file. See to plugin documentation if this method is supported and how!

+ + + + + +

property Certificate: Ansistring read FCertificate write FCertificate;

+Used for loading certificate from binary string. See to plugin documentation if this method is supported and how!

+ + + + + +

property PrivateKey: Ansistring read FPrivateKey write FPrivateKey;

+Used for loading private key from binary string. See to plugin documentation if this method is supported and how!

+ + + + + +

property PFX: Ansistring read FPFX write FPFX;

+Used for loading PFX from binary string. See to plugin documentation if this method is supported and how!

+ + + + + +

property PFXfile: string read FPFXfile write FPFXfile;

+Used for loading PFX from disk file. See to plugin documentation if this method is supported and how!

+ + + + + +

property TrustCertificateFile: string read FTrustCertificateFile write FTrustCertificateFile;

+Used for loading trusted certificates from disk file. See to plugin documentation if this method is supported and how!

+ + + + + +

property TrustCertificate: Ansistring read FTrustCertificate write FTrustCertificate;

+Used for loading trusted certificates from binary string. See to plugin documentation if this method is supported and how!

+ + + + + +

property CertCA: Ansistring read FCertCA write FCertCA;

+Used for loading CA certificates from binary string. See to plugin documentation if this method is supported and how!

+ + + + + +

property CertCAFile: string read FCertCAFile write SetCertCAFile;

+Used for loading CA certificates from disk file. See to plugin documentation if this method is supported and how!

+ + + + + +

property VerifyCert: Boolean read FVerifyCert write FVerifyCert;

+If True, then is verified client certificate. (it is good for writing SSL/TLS servers.) When you are not server, but you are client, then if this property is True, verify servers certificate.

+ + + + + +

property SSHChannelType: string read FSSHChannelType write FSSHChannelType;

+channel type for possible SSH connections

+ + + + + +

property SSHChannelArg1: string read FSSHChannelArg1 write FSSHChannelArg1;

+First argument of channel type for possible SSH connections

+ + + + + +

property SSHChannelArg2: string read FSSHChannelArg2 write FSSHChannelArg2;

+Second argument of channel type for possible SSH connections

+ + + + + +

property CertComplianceLevel: integer read FCertComplianceLevel write FCertComplianceLevel;

+Level of standards compliance level (CryptLib: values in cryptlib.pas, -1: use default value )

+ + + + + +

property OnVerifyCert: THookVerifyCert read FOnVerifyCert write FOnVerifyCert;

+This event is called when verifying the server certificate immediatally after a successfull verification in the ssl library.

+ + + + + +

property SNIHost: string read FSNIHost write FSNIHost;

+Server Name Identification. Host name to send to server. If empty the host name found in URL will be used, which should be the normal use (http Header Host = SNI Host). The value is cleared after the connection is established. (SNI support requires OpenSSL 0.9.8k or later. Cryptlib not supported, yet )

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/blcksock.TDgramBlockSocket.html Index: lib/synapse/docs/help/blcksock.TDgramBlockSocket.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/blcksock.TDgramBlockSocket.html @@ -0,0 +1,73 @@ + + + + + +blcksock: Class TDgramBlockSocket + + + +

Class TDgramBlockSocket

+ + +

Fields

Properties

Unit

Declaration

+type TDgramBlockSocket = class(TSocksBlockSocket)

Description

+Datagram based communication

+ This class implementing datagram based communication instead default stream based communication style.

Hierarchy

TObject
TBlockSocket
TSocksBlockSocket
TDgramBlockSocket

Overview

Methods

+ + + + + + + + + + + + + +

	`procedure Connect(IP, Port: string); override;`
	`function SendBuffer(Buffer: TMemory; Length: Integer): Integer; override;`
	`function RecvBuffer(Buffer: TMemory; Length: Integer): Integer; override;`

Description

Methods

+ + + + + +

procedure Connect(IP, Port: string); override;

+Fill TBlockSocket.RemoteSin structure. This address is used for sending data.

+ + + + + +

function SendBuffer(Buffer: TMemory; Length: Integer): Integer; override;

+Silently redirected to TBlockSocket.SendBufferTo.

+ + + + + +

function RecvBuffer(Buffer: TMemory; Length: Integer): Integer; override;

+Silently redirected to TBlockSocket.RecvBufferFrom.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/blcksock.TICMPBlockSocket.html Index: lib/synapse/docs/help/blcksock.TICMPBlockSocket.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/blcksock.TICMPBlockSocket.html @@ -0,0 +1,62 @@ + + + + + +blcksock: Class TICMPBlockSocket + + + +

Class TICMPBlockSocket

+ + +

Fields

Properties

Unit

Declaration

+type TICMPBlockSocket = class(TDgramBlockSocket)

Description

+Implementation of RAW ICMP socket.

+ For this object you must have rights for creating RAW sockets!

Hierarchy

TObject
TBlockSocket
TSocksBlockSocket
TDgramBlockSocket
TICMPBlockSocket

Overview

Methods

+ + + + + + + + + +

	`function GetSocketType: integer; override;`
	`function GetSocketProtocol: integer; override;`

Description

Methods

+ + + + + +

function GetSocketType: integer; override;

+Return value of socket type. For RAW and ICMP return SOCK_RAW.

+ + + + + +

function GetSocketProtocol: integer; override;

+Return value of protocol type for socket creation. For ICMP returns IPPROTO_ICMP or IPPROTO_ICMPV6

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/blcksock.TIPHeader.html Index: lib/synapse/docs/help/blcksock.TIPHeader.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/blcksock.TIPHeader.html @@ -0,0 +1,121 @@ + + + + + +blcksock: record TIPHeader + + + +

record TIPHeader

+ + +

Hierarchy

Methods

Properties

Unit

Declaration

+type TIPHeader = record

Description

+Record with definition of IP packet header.

+ For reading data from ICMP or RAW sockets.

Overview

Fields

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

VerLen: Byte;

TOS: Byte;

TotalLen: Word;

Identifer: Word;

FragOffsets: Word;

TTL: Byte;

Protocol: Byte;

CheckSum: Word;

SourceIp: LongWord;

DestIp: LongWord;

Options: LongWord;

Description

Fields

+ + + + +

VerLen: Byte;

+ + + + +

TOS: Byte;

+ + + + +

TotalLen: Word;

+ + + + +

Identifer: Word;

+ + + + +

FragOffsets: Word;

+ + + + +

TTL: Byte;

+ + + + +

Protocol: Byte;

+ + + + +

CheckSum: Word;

+ + + + +

SourceIp: LongWord;

+ + + + +

DestIp: LongWord;

+ + + + +

Options: LongWord;

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/blcksock.TPGMMessageBlockSocket.html Index: lib/synapse/docs/help/blcksock.TPGMMessageBlockSocket.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/blcksock.TPGMMessageBlockSocket.html @@ -0,0 +1,60 @@ + + + + + +blcksock: Class TPGMMessageBlockSocket + + + +

Class TPGMMessageBlockSocket

+ + +

Fields

Properties

Unit

Declaration

+type TPGMMessageBlockSocket = class(TBlockSocket)

Description

+Implementation of PGM-message socket.

+ Not all systems supports this protocol!

Hierarchy

TObject
TBlockSocket
TPGMMessageBlockSocket

Overview

Methods

+ + + + + + + + + +

	`function GetSocketType: integer; override;`
	`function GetSocketProtocol: integer; override;`

Description

Methods

+ + + + + +

function GetSocketType: integer; override;

+Return value of socket type. For PGM-message return SOCK_RDM.

+ + + + + +

function GetSocketProtocol: integer; override;

+Return value of protocol type for socket creation. For PGM-message returns IPPROTO_RM.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/blcksock.TPGMStreamBlockSocket.html Index: lib/synapse/docs/help/blcksock.TPGMStreamBlockSocket.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/blcksock.TPGMStreamBlockSocket.html @@ -0,0 +1,60 @@ + + + + + +blcksock: Class TPGMStreamBlockSocket + + + +

Class TPGMStreamBlockSocket

+ + +

Fields

Properties

Unit

Declaration

+type TPGMStreamBlockSocket = class(TBlockSocket)

Description

+Implementation of PGM-stream socket.

+ Not all systems supports this protocol!

Hierarchy

TObject
TBlockSocket
TPGMStreamBlockSocket

Overview

Methods

+ + + + + + + + + +

	`function GetSocketType: integer; override;`
	`function GetSocketProtocol: integer; override;`

Description

Methods

+ + + + + +

function GetSocketType: integer; override;

+Return value of socket type. For PGM-stream return SOCK_STREAM.

+ + + + + +

function GetSocketProtocol: integer; override;

+Return value of protocol type for socket creation. For PGM-stream returns IPPROTO_RM.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/blcksock.TRAWBlockSocket.html Index: lib/synapse/docs/help/blcksock.TRAWBlockSocket.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/blcksock.TRAWBlockSocket.html @@ -0,0 +1,60 @@ + + + + + +blcksock: Class TRAWBlockSocket + + + +

Class TRAWBlockSocket

+ + +

Fields

Properties

Unit

Declaration

+type TRAWBlockSocket = class(TBlockSocket)

Description

+Implementation of RAW socket.

+ For this object you must have rights for creating RAW sockets!

Hierarchy

TObject
TBlockSocket
TRAWBlockSocket

Overview

Methods

+ + + + + + + + + +

	`function GetSocketType: integer; override;`
	`function GetSocketProtocol: integer; override;`

Description

Methods

+ + + + + +

function GetSocketType: integer; override;

+Return value of socket type. For RAW and ICMP return SOCK_RAW.

+ + + + + +

function GetSocketProtocol: integer; override;

+Return value of protocol type for socket creation. For RAW returns IPPROTO_RAW.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/blcksock.TSSLNone.html Index: lib/synapse/docs/help/blcksock.TSSLNone.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/blcksock.TSSLNone.html @@ -0,0 +1,60 @@ + + + + + +blcksock: Class TSSLNone + + + +

Class TSSLNone

+ + +

Fields

Properties

Unit

Declaration

+type TSSLNone = class(TCustomSSL)

Description

+Default SSL plugin with no SSL support.

+ Dummy SSL plugin implementation for applications without SSL/TLS support.

Hierarchy

TObject
TCustomSSL
TSSLNone

Overview

Methods

+ + + + + + + + + +

	`function LibVersion: String; override;`
	`function LibName: String; override;`

Description

Methods

+ + + + + +

function LibVersion: String; override;

+ + + + + +

function LibName: String; override;

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/blcksock.TSocksBlockSocket.html Index: lib/synapse/docs/help/blcksock.TSocksBlockSocket.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/blcksock.TSocksBlockSocket.html @@ -0,0 +1,194 @@ + + + + + +blcksock: Class TSocksBlockSocket + + + +

Class TSocksBlockSocket

+ + +

Fields

Unit

Declaration

+type TSocksBlockSocket = class(TBlockSocket)

Description

+Support for SOCKS4 and SOCKS5 proxy

+ Layer with definition all necessary properties and functions for implementation SOCKS proxy client. Do not use this class directly.

Hierarchy

TObject
TBlockSocket
TSocksBlockSocket

Overview

Methods

+ + + + + + + + + + + + + + + + + +

	`constructor Create;`
	`function SocksOpen: Boolean;`
	`function SocksRequest(Cmd: Byte; const IP, Port: string): Boolean;`
	`function SocksResponse: Boolean;`

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`property UsingSocks: Boolean read FUsingSocks;`
	`property SocksLastError: integer read FSocksLastError;`
	`property SocksIP: string read FSocksIP write FSocksIP;`
	`property SocksPort: string read FSocksPort write FSocksPort;`
	`property SocksUsername: string read FSocksUsername write FSocksUsername;`
	`property SocksPassword: string read FSocksPassword write FSocksPassword;`
	`property SocksTimeout: integer read FSocksTimeout write FSocksTimeout;`
	`property SocksResolver: Boolean read FSocksResolver write FSocksResolver;`
	`property SocksType: TSocksType read FSocksType write FSocksType;`

Description

Methods

+ + + + + +

constructor Create;

+ + + + + +

function SocksOpen: Boolean;

+Open connection to SOCKS proxy and if SocksUsername is set, do authorisation to proxy. This is needed only in special cases! (it is called internally!)

+ + + + + +

function SocksRequest(Cmd: Byte; const IP, Port: string): Boolean;

+Send specified request to SOCKS proxy. This is needed only in special cases! (it is called internally!)

+ + + + + +

function SocksResponse: Boolean;

+Receive response to previosly sended request. This is needed only in special cases! (it is called internally!)

Properties

+ + + + + +

property UsingSocks: Boolean read FUsingSocks;

+Is True when class is using SOCKS proxy.

+ + + + + +

property SocksLastError: integer read FSocksLastError;

+If SOCKS proxy failed, here is error code returned from SOCKS proxy.

+ + + + + +

property SocksIP: string read FSocksIP write FSocksIP;

+Address of SOCKS server. If value is empty string, SOCKS support is disabled. Assingning any value to this property enable SOCKS mode. Warning: You cannot combine this mode with HTTP-tunneling mode!

+ + + + + +

property SocksPort: string read FSocksPort write FSocksPort;

+Port of SOCKS server. Default value is '1080'.

+ + + + + +

property SocksUsername: string read FSocksUsername write FSocksUsername;

+If you need authorisation on SOCKS server, set username here.

+ + + + + +

property SocksPassword: string read FSocksPassword write FSocksPassword;

+If you need authorisation on SOCKS server, set password here.

+ + + + + +

property SocksTimeout: integer read FSocksTimeout write FSocksTimeout;

+Specify timeout for communicatin with SOCKS server. Default is one minute.

+ + + + + +

property SocksResolver: Boolean read FSocksResolver write FSocksResolver;

+If True, all symbolic names of target hosts is not translated to IP's locally, but resolving is by SOCKS proxy. Default is True.

+ + + + + +

property SocksType: TSocksType read FSocksType write FSocksType;

+Specify SOCKS type. By default is used SOCKS5, but you can use SOCKS4 too. When you select SOCKS4, then if SocksResolver is enabled, then is used SOCKS4a. Othervise is used pure SOCKS4.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/blcksock.TSynaClient.html Index: lib/synapse/docs/help/blcksock.TSynaClient.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/blcksock.TSynaClient.html @@ -0,0 +1,121 @@ + + + + + +blcksock: Class TSynaClient + + + +

Class TSynaClient

+ + +

Fields

Unit

Declaration

+type TSynaClient = class(TObject)

Description

+Parent class of application protocol implementations.

+ By this class is defined common properties.

Hierarchy

TObject
TSynaClient

Overview

Methods

+ + + + + +

constructor Create;

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + +

	`property TargetHost: string read FTargetHost Write FTargetHost;`
	`property TargetPort: string read FTargetPort Write FTargetPort;`
	`property IPInterface: string read FIPInterface Write FIPInterface;`
	`property Timeout: integer read FTimeout Write FTimeout;`
	`property UserName: string read FUserName Write FUserName;`
	`property Password: string read FPassword Write FPassword;`

Description

Methods

+ + + + + +

constructor Create;

Properties

+ + + + + +

property TargetHost: string read FTargetHost Write FTargetHost;

+Specify terget server IP (or symbolic name). Default is 'localhost'.

+ + + + + +

property TargetPort: string read FTargetPort Write FTargetPort;

+Specify terget server port (or symbolic name).

+ + + + + +

property IPInterface: string read FIPInterface Write FIPInterface;

+Defined local socket address. (outgoing IP address). By default is used '0.0.0.0' as wildcard for default IP.

+ + + + + +

property Timeout: integer read FTimeout Write FTimeout;

+Specify default timeout for socket operations.

+ + + + + +

property UserName: string read FUserName Write FUserName;

+If protocol need user authorization, then fill here username.

+ + + + + +

property Password: string read FPassword Write FPassword;

+If protocol need user authorization, then fill here password.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/blcksock.TSynaOption.html Index: lib/synapse/docs/help/blcksock.TSynaOption.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/blcksock.TSynaOption.html @@ -0,0 +1,63 @@ + + + + + +blcksock: Class TSynaOption + + + +

Class TSynaOption

+ + +

Methods

Properties

Unit

Declaration

+type TSynaOption = class(TObject)

Description

+this object is used for remember delayed socket option set.

Hierarchy

TObject
TSynaOption

Overview

Fields

+ + + + + + + + + + + + + +

	`Option: TSynaOptionType;`
	`Enabled: Boolean;`
	`Value: Integer;`

Description

Fields

+ + + + + +

Option: TSynaOptionType;

+ + + + + +

Enabled: Boolean;

+ + + + + +

Value: Integer;

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/blcksock.TTCPBlockSocket.html Index: lib/synapse/docs/help/blcksock.TTCPBlockSocket.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/blcksock.TTCPBlockSocket.html @@ -0,0 +1,385 @@ + + + + + +blcksock: Class TTCPBlockSocket + + + +

Class TTCPBlockSocket

+ + +

Fields

Unit

Declaration

+type TTCPBlockSocket = class(TSocksBlockSocket)

Description

+Implementation of TCP socket.

+ Supported features: IPv4, IPv6, SSL/TLS or SSH (depending on used plugin), SOCKS5 proxy (outgoing connections and limited incomming), SOCKS4/4a proxy (outgoing connections and limited incomming), TCP through HTTP proxy tunnel.

Hierarchy

TObject
TBlockSocket
TSocksBlockSocket
TTCPBlockSocket

Overview

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`constructor Create;`
	`constructor CreateWithSSL(SSLPlugin: TSSLClass);`
	`destructor Destroy; override;`
	`procedure CloseSocket; override;`
	`function WaitingData: Integer; override;`
	`procedure Listen; override;`
	`function Accept: TSocket; override;`
	`procedure Connect(IP, Port: string); override;`
	`procedure SSLDoConnect;`
	`procedure SSLDoShutdown;`
	`function SSLAcceptConnection: Boolean;`
	`function GetLocalSinIP: string; override;`
	`function GetRemoteSinIP: string; override;`
	`function GetLocalSinPort: Integer; override;`
	`function GetRemoteSinPort: Integer; override;`
	`function SendBuffer(Buffer: TMemory; Length: Integer): Integer; override;`
	`function RecvBuffer(Buffer: TMemory; Len: Integer): Integer; override;`
	`function GetSocketType: integer; override;`
	`function GetSocketProtocol: integer; override;`
	`function GetErrorDescEx: string; override;`

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`property SSL: TCustomSSL read FSSL;`
	`property HTTPTunnel: Boolean read FHTTPTunnel;`
	`property HTTPTunnelIP: string read FHTTPTunnelIP Write FHTTPTunnelIP;`
	`property HTTPTunnelPort: string read FHTTPTunnelPort Write FHTTPTunnelPort;`
	`property HTTPTunnelUser: string read FHTTPTunnelUser Write FHTTPTunnelUser;`
	`property HTTPTunnelPass: string read FHTTPTunnelPass Write FHTTPTunnelPass;`
	`property HTTPTunnelTimeout: integer read FHTTPTunnelTimeout Write FHTTPTunnelTimeout;`
	`property OnAfterConnect: THookAfterConnect read FOnAfterConnect write FOnAfterConnect;`

Description

Methods

+ + + + + +

constructor Create;

+Create TCP socket class with default plugin for SSL/TSL/SSH implementation (see SSLImplementation)

+ + + + + +

constructor CreateWithSSL(SSLPlugin: TSSLClass);

+Create TCP socket class with desired plugin for SSL/TSL/SSH implementation

+ + + + + +

destructor Destroy; override;

+ + + + + +

procedure CloseSocket; override;

+See TBlockSocket.CloseSocket

+ + + + + +

function WaitingData: Integer; override;

+See TBlockSocket.WaitingData

+ + + + + +

procedure Listen; override;

+Sets socket to receive mode for new incoming connections. It is necessary to use TBlockSocket.Bind function call before this method to select receiving port! + +

If you use SOCKS, activate incoming TCP connection by this proxy. (By BIND method of SOCKS.)

+ + + + + +

function Accept: TSocket; override;

+Waits until new incoming connection comes. After it comes a new socket is automatically created (socket handler is returned by this function as result). + +

If you use SOCKS, new socket is not created! In this case is used same socket as socket for listening! So, you can accept only one connection in SOCKS mode.

+ + + + + +

procedure Connect(IP, Port: string); override;

+Connects socket to remote IP address and PORT. The same rules as with TBlockSocket.Bind method are valid. The only exception is that PORT with 0 value will not be connected. After call to this method a communication channel between local and remote socket is created. Local socket is assigned automatically if not controlled by previous call to TBlockSocket.Bind method. Structures TBlockSocket.LocalSin and TBlockSocket.RemoteSin will be filled with valid values. + +

If you use SOCKS, activate outgoing TCP connection by SOCKS proxy specified in TSocksBlockSocket.SocksIP. (By CONNECT method of SOCKS.) + +

If you use HTTP-tunnel mode, activate outgoing TCP connection by HTTP tunnel specified in HTTPTunnelIP. (By CONNECT method of HTTP protocol.) + +

Note: If you call this on non-created socket, then socket is created automaticly.

+ + + + + +

procedure SSLDoConnect;

+If you need upgrade existing TCP connection to SSL/TLS (or SSH2, if plugin allows it) mode, then call this method. This method switch this class to SSL mode and do SSL/TSL handshake.

+ + + + + +

procedure SSLDoShutdown;

+By this method you can downgrade existing SSL/TLS connection to normal TCP connection.

+ + + + + +

function SSLAcceptConnection: Boolean;

+If you need use this component as SSL/TLS TCP server, then after accepting of inbound connection you need start SSL/TLS session by this method. Before call this function, you must have assigned all neeeded certificates and keys!

+ + + + + +

function GetLocalSinIP: string; override;

+See TBlockSocket.GetLocalSinIP

+ + + + + +

function GetRemoteSinIP: string; override;

+See TBlockSocket.GetRemoteSinIP

+ + + + + +

function GetLocalSinPort: Integer; override;

+See TBlockSocket.GetLocalSinPort

+ + + + + +

function GetRemoteSinPort: Integer; override;

+See TBlockSocket.GetRemoteSinPort

+ + + + + +

function SendBuffer(Buffer: TMemory; Length: Integer): Integer; override;

+See TBlockSocket.SendBuffer

+ + + + + +

function RecvBuffer(Buffer: TMemory; Len: Integer): Integer; override;

+See TBlockSocket.RecvBuffer

+ + + + + +

function GetSocketType: integer; override;

+Return value of socket type. For TCP return SOCK_STREAM.

+ + + + + +

function GetSocketProtocol: integer; override;

+Return value of protocol type for socket creation. For TCP return IPPROTO_TCP.

+ + + + + +

function GetErrorDescEx: string; override;

+Return descriptive string for LastError. On case of error in SSL/TLS subsystem, it returns right error description.

Properties

+ + + + + +

property SSL: TCustomSSL read FSSL;

+Class implementing SSL/TLS support. It is allways some descendant of TCustomSSL class. When programmer not select some SSL plugin class, then is used TSSLNone

+ + + + + +

property HTTPTunnel: Boolean read FHTTPTunnel;

+True if is used HTTP tunnel mode.

+ + + + + +

property HTTPTunnelIP: string read FHTTPTunnelIP Write FHTTPTunnelIP;

+Specify IP address of HTTP proxy. Assingning non-empty value to this property enable HTTP-tunnel mode. This mode is for tunnelling any outgoing TCP connection through HTTP proxy server. (If policy on HTTP proxy server allow this!) Warning: You cannot combine this mode with SOCK5 mode!

+ + + + + +

property HTTPTunnelPort: string read FHTTPTunnelPort Write FHTTPTunnelPort;

+Specify port of HTTP proxy for HTTP-tunneling.

+ + + + + +

property HTTPTunnelUser: string read FHTTPTunnelUser Write FHTTPTunnelUser;

+Specify authorisation username for access to HTTP proxy in HTTP-tunnel mode. If you not need authorisation, then let this property empty.

+ + + + + +

property HTTPTunnelPass: string read FHTTPTunnelPass Write FHTTPTunnelPass;

+Specify authorisation password for access to HTTP proxy in HTTP-tunnel mode.

+ + + + + +

property HTTPTunnelTimeout: integer read FHTTPTunnelTimeout Write FHTTPTunnelTimeout;

+Specify timeout for communication with HTTP proxy in HTTPtunnel mode.

+ + + + + +

property OnAfterConnect: THookAfterConnect read FOnAfterConnect write FOnAfterConnect;

+This event is called after sucessful TCP socket connection.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/blcksock.TUDPBlockSocket.html Index: lib/synapse/docs/help/blcksock.TUDPBlockSocket.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/blcksock.TUDPBlockSocket.html @@ -0,0 +1,162 @@ + + + + + +blcksock: Class TUDPBlockSocket + + + +

Class TUDPBlockSocket

+ + +

Fields

Unit

Declaration

+type TUDPBlockSocket = class(TDgramBlockSocket)

Description

+Implementation of UDP socket.

+ NOTE: in this class is all receiving redirected to RecvBufferFrom. You can use for reading any receive function. Preffered is RecvPacket! Similary all sending is redirected to SendbufferTo. You can use for sending UDP packet any sending function, like SendString. + +

Supported features: IPv4, IPv6, unicasts, broadcasts, multicasts, SOCKS5 proxy (only unicasts! Outgoing and incomming.)

Hierarchy

TObject
TBlockSocket
TSocksBlockSocket
TDgramBlockSocket
TUDPBlockSocket

Overview

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`destructor Destroy; override;`
	`procedure EnableBroadcast(Value: Boolean);`
	`function SendBufferTo(Buffer: TMemory; Length: Integer): Integer; override;`
	`function RecvBufferFrom(Buffer: TMemory; Length: Integer): Integer; override;`
	`procedure AddMulticast(MCastIP:string);`
	`procedure DropMulticast(MCastIP:string);`
	`procedure EnableMulticastLoop(Value: Boolean);`
	`function GetSocketType: integer; override;`
	`function GetSocketProtocol: integer; override;`

Properties

+ + + + + +

property MulticastTTL: Integer read GetMulticastTTL Write SetMulticastTTL;

Description

Methods

+ + + + + +

destructor Destroy; override;

+ + + + + +

procedure EnableBroadcast(Value: Boolean);

+Enable or disable sending of broadcasts. If seting OK, result is True. This method is not supported in SOCKS5 mode! IPv6 does not support broadcasts! In this case you must use Multicasts instead.

+ + + + + +

function SendBufferTo(Buffer: TMemory; Length: Integer): Integer; override;

+See TBlockSocket.SendBufferTo

+ + + + + +

function RecvBufferFrom(Buffer: TMemory; Length: Integer): Integer; override;

+See TBlockSocket.RecvBufferFrom

+ + + + + +

procedure AddMulticast(MCastIP:string);

+Add this socket to given multicast group. You cannot use Multicasts in SOCKS mode!

+ + + + + +

procedure DropMulticast(MCastIP:string);

+Remove this socket from given multicast group.

+ + + + + +

procedure EnableMulticastLoop(Value: Boolean);

+All sended multicast datagrams is loopbacked to your interface too. (you can read your sended datas.) You can disable this feature by this function. This function not working on some Windows systems!

+ + + + + +

function GetSocketType: integer; override;

+Return value of socket type. For UDP return SOCK_DGRAM.

+ + + + + +

function GetSocketProtocol: integer; override;

+Return value of protocol type for socket creation. For UDP return IPPROTO_UDP.

Properties

+ + + + + +

property MulticastTTL: Integer read GetMulticastTTL Write SetMulticastTTL;

+Set Time-to-live value for multicasts packets. It define number of routers for transfer of datas. If you set this to 1 (dafault system value), then multicasts packet goes only to you local network. If you need transport multicast packet to worldwide, then increase this value, but be carefull, lot of routers on internet does not transport multicasts packets!

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/blcksock.html Index: lib/synapse/docs/help/blcksock.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/blcksock.html @@ -0,0 +1,419 @@ + + + + + +blcksock + + + +

Unit blcksock

+ + +

Functions and Procedures

Description

uses

SysUtils
Classes
synafpc
synsock
synautil
synacode
synaip

Overview

Classes, Interfaces, Objects and Records

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Name	Description
Class `ESynapseError`	Exception clas used by Synapse
Class `TSynaOption`	this object is used for remember delayed socket option set.
Class `TBlockSocket`	Basic IP object.
Class `TSocksBlockSocket`	Support for SOCKS4 and SOCKS5 proxy
Class `TTCPBlockSocket`	Implementation of TCP socket.
Class `TDgramBlockSocket`	Datagram based communication
Class `TUDPBlockSocket`	Implementation of UDP socket.
Class `TICMPBlockSocket`	Implementation of RAW ICMP socket.
Class `TRAWBlockSocket`	Implementation of RAW socket.
Class `TPGMMessageBlockSocket`	Implementation of PGM-message socket.
Class `TPGMStreamBlockSocket`	Implementation of PGM-stream socket.
Class `TCustomSSL`	Parent class for all SSL plugins.
Class `TSSLNone`	Default SSL plugin with no SSL support.
record `TIPHeader`	Record with definition of IP packet header.
Class `TSynaClient`	Parent class of application protocol implementations.

Types

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

THookSocketReason = (...);

THookSocketStatus = procedure(Sender: TObject; Reason: THookSocketReason; const Value: String) of object;

THookDataFilter = procedure(Sender: TObject; var Value: AnsiString) of object;

THookCreateSocket = procedure(Sender: TObject) of object;

THookMonitor = procedure(Sender: TObject; Writing: Boolean; const Buffer: TMemory; Len: Integer) of object;

THookAfterConnect = procedure(Sender: TObject) of object;

THookVerifyCert = function(Sender: TObject):boolean of object;

THookHeartbeat = procedure(Sender: TObject) of object;

TSocketFamily = (...);

TSocksType = (...);

TSSLType = (...);

TSynaOptionType = (...);

TSSLClass = class of TCustomSSL;

Constants

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

SynapseRelease = '38';

cLocalhost = '127.0.0.1';

cAnyHost = '0.0.0.0';

cBroadcast = '255.255.255.255';

c6Localhost = '::1';

c6AnyHost = '::0';

c6Broadcast = 'ffff::1';

cAnyPort = '0';

CR = #$0d;

LF = #$0a;

CRLF = CR + LF;

c64k = 65536;

Variables

+ + + + +

SSLImplementation: TSSLClass = TSSLNone;

Description

Types

+ + + + +

THookSocketReason = (...);

+Types of OnStatus events

+HR_ResolvingBegin: Resolving is begin. Resolved IP and port is in parameter in format like: 'localhost.somewhere.com:25'.
+HR_ResolvingEnd: Resolving is done. Resolved IP and port is in parameter in format like: 'localhost.somewhere.com:25'. It is always same as in HR_ResolvingBegin!
+HR_SocketCreate: Socket created by CreateSocket method. It reporting Family of created socket too!
+HR_SocketClose: Socket closed by CloseSocket method.
+HR_Bind: Socket binded to IP and Port. Binded IP and Port is in parameter in format like: 'localhost.somewhere.com:25'.
+HR_Connect: Socket connected to IP and Port. Connected IP and Port is in parameter in format like: 'localhost.somewhere.com:25'.
+HR_CanRead: Called when CanRead method is used with True result.
+HR_CanWrite: Called when CanWrite method is used with True result.
+HR_Listen: Socket is swithed to Listen mode. (TCP socket only)
+HR_Accept: Socket Accepting client connection. (TCP socket only)
+HR_ReadCount: report count of bytes readed from socket. Number is in parameter string. If you need is in integer, you must use StrToInt function!
+HR_WriteCount: report count of bytes writed to socket. Number is in parameter string. If you need is in integer, you must use StrToInt function!
+HR_Wait: If is limiting of bandwidth on, then this reason is called when sending or receiving is stopped for satisfy bandwidth limit. Parameter is count of waiting milliseconds.
+HR_Error: report situation where communication error occured. When raiseexcept is True, then exception is called after this Hook reason.

+ + + + +

THookSocketStatus = procedure(Sender: TObject; Reason: THookSocketReason; const Value: String) of object;

+Procedural type for OnStatus event. Sender is calling TBlockSocket object, Reason is one of set Status events and value is optional data.

+ + + + +

THookDataFilter = procedure(Sender: TObject; var Value: AnsiString) of object;

+This procedural type is used for DataFilter hooks.

+ + + + +

THookCreateSocket = procedure(Sender: TObject) of object;

+This procedural type is used for hook OnCreateSocket. By this hook you can insert your code after initialisation of socket. (you can set special socket options, etc.)

+ + + + +

THookMonitor = procedure(Sender: TObject; Writing: Boolean; const Buffer: TMemory; Len: Integer) of object;

+This procedural type is used for monitoring of communication.

+ + + + +

THookAfterConnect = procedure(Sender: TObject) of object;

+This procedural type is used for hook OnAfterConnect. By this hook you can insert your code after TCP socket has been sucessfully connected.

+ + + + +

THookVerifyCert = function(Sender: TObject):boolean of object;

+This procedural type is used for hook OnVerifyCert. By this hook you can insert your additional certificate verification code. Usefull to verify server CN against URL.

+ + + + +

THookHeartbeat = procedure(Sender: TObject) of object;

+This procedural type is used for hook OnHeartbeat. By this hook you can call your code repeately during long socket operations. You must enable heartbeats by HeartbeatRate property!

+ + + + +

TSocketFamily = (...);

+Specify family of socket.

+SF_Any: Default mode. Socket family is defined by target address for connection. It allows instant access to IPv4 and IPv6 nodes. When you need IPv6 address as destination, then is used IPv6 mode. othervise is used IPv4 mode. However this mode not working properly with preliminary IPv6 supports!
+SF_IP4: Turn this class to pure IPv4 mode. This mode is totally compatible with previous Synapse releases.
+SF_IP6: Turn to only IPv6 mode.

+ + + + +

TSocksType = (...);

+specify possible values of SOCKS modes.

+ST_Socks5:
+ST_Socks4:

+ + + + +

TSSLType = (...);

+Specify requested SSL/TLS version for secure connection.

+LT_all:
+LT_SSLv2:
+LT_SSLv3:
+LT_TLSv1:
+LT_TLSv1_1:
+LT_SSHv2:

+ + + + +

TSynaOptionType = (...);

+Specify type of socket delayed option.

+SOT_Linger:
+SOT_RecvBuff:
+SOT_SendBuff:
+SOT_NonBlock:
+SOT_RecvTimeout:
+SOT_SendTimeout:
+SOT_Reuse:
+SOT_TTL:
+SOT_Broadcast:
+SOT_MulticastTTL:
+SOT_MulticastLoop:

+ + + + +

TSSLClass = class of TCustomSSL;

Constants

+ + + + +

SynapseRelease = '38';

+ + + + +

cLocalhost = '127.0.0.1';

+ + + + +

cAnyHost = '0.0.0.0';

+ + + + +

cBroadcast = '255.255.255.255';

+ + + + +

c6Localhost = '::1';

+ + + + +

c6AnyHost = '::0';

+ + + + +

c6Broadcast = 'ffff::1';

+ + + + +

cAnyPort = '0';

+ + + + +

CR = #$0d;

+ + + + +

LF = #$0a;

+ + + + +

CRLF = CR + LF;

+ + + + +

c64k = 65536;

Variables

+ + + + +

SSLImplementation: TSSLClass = TSSLNone;

+Selected SSL plugin. Default is TSSLNone. + +

Do not change this value directly!!! + +

Just add your plugin unit to your project uses instead. Each plugin unit have initialization code what modify this variable.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/clamsend.TClamSend.html Index: lib/synapse/docs/help/clamsend.TClamSend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/clamsend.TClamSend.html @@ -0,0 +1,170 @@ + + + + + +clamsend: Class TClamSend + + + +

Class TClamSend

+ + +

Fields

Unit

+clamsend

Declaration

+type TClamSend = class(TSynaClient)

Description

+Implementation of ClamAV-daemon client protocol

+ By this class you can scan any your data by ClamAV opensource antivirus. + +

This class can connect to ClamD by TCP channel, send your data to ClamD and read result.

Hierarchy

TObject
TSynaClient
TClamSend

Overview

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`constructor Create;`
	`destructor Destroy; override;`
	`function DoCommand(const Value: AnsiString): AnsiString; virtual;`
	`function GetVersion: AnsiString; virtual;`
	`function ScanStrings(const Value: TStrings): AnsiString; virtual;`
	`function ScanStream(const Value: TStream): AnsiString; virtual;`
	`function ScanStrings2(const Value: TStrings): AnsiString; virtual;`
	`function ScanStream2(const Value: TStream): AnsiString; virtual;`

Properties

+ + + + + + + + + + + + + +

	`property Sock: TTCPBlockSocket read FSock;`
	`property DSock: TTCPBlockSocket read FDSock;`
	`property Session: boolean read FSession write FSession;`

Description

Methods

+ + + + + +

constructor Create;

+ + + + + +

destructor Destroy; override;

+ + + + + +

function DoCommand(const Value: AnsiString): AnsiString; virtual;

+Call any command to ClamD. Used internally by other methods.

+ + + + + +

function GetVersion: AnsiString; virtual;

+Return ClamAV version and version of loaded databases.

+ + + + + +

function ScanStrings(const Value: TStrings): AnsiString; virtual;

+Scan content of TStrings.

+ + + + + +

function ScanStream(const Value: TStream): AnsiString; virtual;

+Scan content of TStream.

+ + + + + +

function ScanStrings2(const Value: TStrings): AnsiString; virtual;

+Scan content of TStrings by new 0.95 API.

+ + + + + +

function ScanStream2(const Value: TStream): AnsiString; virtual;

+Scan content of TStream by new 0.95 API.

Properties

+ + + + + +

property Sock: TTCPBlockSocket read FSock;

+Socket object used for TCP/IP operation. Good for seting OnStatus hook, etc.

+ + + + + +

property DSock: TTCPBlockSocket read FDSock;

+Socket object used for TCP data transfer operation. Good for seting OnStatus hook, etc.

+ + + + + +

property Session: boolean read FSession write FSession;

+Can turn-on session mode of communication with ClamD. Default is False, because ClamAV developers design their TCP code very badly and session mode is broken now (CVS-20051031). Maybe ClamAV developers fix their bugs and this mode will be possible in future.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/clamsend.html Index: lib/synapse/docs/help/clamsend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/clamsend.html @@ -0,0 +1,49 @@ + + + + + +clamsend + + + +

Unit clamsend

+ + +

Functions and Procedures

Types

Variables

Description

+ ClamAV-daemon client

+ + +

This unit is capable to do antivirus scan of your data by TCP channel to ClamD daemon from ClamAV. See more about ClamAV on UNKNOWN

uses

SysUtils
Classes
synsock
blcksock
synautil

Overview

Classes, Interfaces, Objects and Records

+ + + + + + + + + +

Name	Description
Class `TClamSend`	Implementation of ClamAV-daemon client protocol

Constants

+ + + + +

cClamProtocol = '3310';

Description

Constants

+ + + + +

cClamProtocol = '3310';

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/dnssend.TDNSSend.html Index: lib/synapse/docs/help/dnssend.TDNSSend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/dnssend.TDNSSend.html @@ -0,0 +1,188 @@ + + + + + +dnssend: Class TDNSSend + + + +

Class TDNSSend

+ + +

Fields

Unit

+dnssend

Declaration

+type TDNSSend = class(TSynaClient)

Description

+Implementation of DNS protocol by UDP or TCP protocol.

+ + +

Note: Are you missing properties for specify server address and port? Look to parent TSynaClient too!

Hierarchy

TObject
TSynaClient
TDNSSend

Overview

Methods

+ + + + + + + + + + + + + +

	`constructor Create;`
	`destructor Destroy; override;`
	`function DNSQuery(Name: AnsiString; QType: Integer; const Reply: TStrings): Boolean;`

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`property Sock: TUDPBlockSocket read FSock;`
	`property TCPSock: TTCPBlockSocket read FTCPSock;`
	`property UseTCP: Boolean read FUseTCP Write FUseTCP;`
	`property RCode: Integer read FRCode;`
	`property Authoritative: Boolean read FAuthoritative;`
	`property Truncated: Boolean read FTRuncated;`
	`property AnswerInfo: TStringList read FAnswerInfo;`
	`property NameserverInfo: TStringList read FNameserverInfo;`
	`property AdditionalInfo: TStringList read FAdditionalInfo;`

Description

Methods

+ + + + + +

constructor Create;

+ + + + + +

destructor Destroy; override;

+ + + + + +

function DNSQuery(Name: AnsiString; QType: Integer; const Reply: TStrings): Boolean;

+Query a DNSHost for QType resources correspond to a name. Supported QType values are: Qtype_A, Qtype_NS, Qtype_MD, Qtype_MF, Qtype_CNAME, Qtype_SOA, Qtype_MB, Qtype_MG, Qtype_MR, Qtype_NULL, Qtype_PTR, Qtype_HINFO, Qtype_MINFO, Qtype_MX, Qtype_TXT, Qtype_RP, Qtype_AFSDB, Qtype_X25, Qtype_ISDN, Qtype_RT, Qtype_NSAP, Qtype_NSAPPTR, Qtype_PX, Qtype_GPOS, Qtype_KX. + +

Type for zone transfers QTYPE_AXFR is supported too, but only in TCP mode! + +

"Name" is domain name or host name for queried resource. If "name" is IP address, automatically convert to reverse domain form (.in-addr.arpa). + +

Properties

+ + + + + +

property Sock: TUDPBlockSocket read FSock;

+Socket object used for UDP operation. Good for seting OnStatus hook, etc.

+ + + + + +

property TCPSock: TTCPBlockSocket read FTCPSock;

+Socket object used for TCP operation. Good for seting OnStatus hook, etc.

+ + + + + +

property UseTCP: Boolean read FUseTCP Write FUseTCP;

+if True, then is used TCP protocol instead UDP. It is needed for zone transfers, etc.

+ + + + + +

property RCode: Integer read FRCode;

+After DNS operation contains ResultCode of DNS operation. Values are: 0-no error, 1-format error, 2-server failure, 3-name error, 4-not implemented, 5-refused.

+ + + + + +

property Authoritative: Boolean read FAuthoritative;

+True, if answer is authoritative.

+ + + + + +

property Truncated: Boolean read FTRuncated;

+True, if answer is truncated to 512 bytes.

+ + + + + +

property AnswerInfo: TStringList read FAnswerInfo;

+Detailed informations from name server reply. One record per line. Record have comma delimited entries with type number, TTL and data filelds. This information contains detailed information about query reply.

+ + + + + +

property NameserverInfo: TStringList read FNameserverInfo;

+ + + + + +

property AdditionalInfo: TStringList read FAdditionalInfo;

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/dnssend.html Index: lib/synapse/docs/help/dnssend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/dnssend.html @@ -0,0 +1,367 @@ + + + + + +dnssend + + + +

Unit dnssend

+ + +

Types

Variables

Description

+DNS client by UDP or TCP

+ Support for sending DNS queries by UDP or TCP protocol. It can retrieve zone transfers too! + +

Used RFC: RFC-1035, RFC-1183, RFC1706, RFC1712, RFC2163, RFC2230

uses

SysUtils
Classes
blcksock
synautil
synaip
synsock

Overview

Classes, Interfaces, Objects and Records

+ + + + + + + + + +

Name	Description
Class `TDNSSend`	Implementation of DNS protocol by UDP or TCP protocol.

Functions and Procedures

+ + + + +

function GetMailServers(const DNSHost, Domain: AnsiString; const Servers: TStrings): Boolean;

Constants

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

cDnsProtocol = '53';

QTYPE_A = 1;

QTYPE_NS = 2;

QTYPE_MD = 3;

QTYPE_MF = 4;

QTYPE_CNAME = 5;

QTYPE_SOA = 6;

QTYPE_MB = 7;

QTYPE_MG = 8;

QTYPE_MR = 9;

QTYPE_NULL = 10;

QTYPE_WKS = 11;

QTYPE_PTR = 12;

QTYPE_HINFO = 13;

QTYPE_MINFO = 14;

QTYPE_MX = 15;

QTYPE_TXT = 16;

QTYPE_RP = 17;

QTYPE_AFSDB = 18;

QTYPE_X25 = 19;

QTYPE_ISDN = 20;

QTYPE_RT = 21;

QTYPE_NSAP = 22;

QTYPE_NSAPPTR = 23;

QTYPE_SIG = 24;

QTYPE_KEY = 25;

QTYPE_PX = 26;

QTYPE_GPOS = 27;

QTYPE_AAAA = 28;

QTYPE_LOC = 29;

QTYPE_NXT = 30;

QTYPE_SRV = 33;

QTYPE_NAPTR = 35;

QTYPE_KX = 36;

QTYPE_SPF = 99;

QTYPE_AXFR = 252;

QTYPE_MAILB = 253;

QTYPE_MAILA = 254;

QTYPE_ALL = 255;

Description

Functions and Procedures

+ + + + +

function GetMailServers(const DNSHost, Domain: AnsiString; const Servers: TStrings): Boolean;

+A very useful function, and example of it's use is found in the TDNSSend object. This function is used to get mail servers for a domain and sort them by preference numbers. "Servers" contains only the domain names of the mail servers in the right order (without preference number!). The first domain name will always be the highest preferenced mail server. Returns boolean True if all went well.

Constants

+ + + + +

cDnsProtocol = '53';

+ + + + +

QTYPE_A = 1;

+ + + + +

QTYPE_NS = 2;

+ + + + +

QTYPE_MD = 3;

+ + + + +

QTYPE_MF = 4;

+ + + + +

QTYPE_CNAME = 5;

+ + + + +

QTYPE_SOA = 6;

+ + + + +

QTYPE_MB = 7;

+ + + + +

QTYPE_MG = 8;

+ + + + +

QTYPE_MR = 9;

+ + + + +

QTYPE_NULL = 10;

+ + + + +

QTYPE_WKS = 11;

+ + + + +

QTYPE_PTR = 12;

+ + + + +

QTYPE_HINFO = 13;

+ + + + +

QTYPE_MINFO = 14;

+ + + + +

QTYPE_MX = 15;

+ + + + +

QTYPE_TXT = 16;

+ + + + +

QTYPE_RP = 17;

+ + + + +

QTYPE_AFSDB = 18;

+ + + + +

QTYPE_X25 = 19;

+ + + + +

QTYPE_ISDN = 20;

+ + + + +

QTYPE_RT = 21;

+ + + + +

QTYPE_NSAP = 22;

+ + + + +

QTYPE_NSAPPTR = 23;

+ + + + +

QTYPE_SIG = 24;

+ + + + +

QTYPE_KEY = 25;

+ + + + +

QTYPE_PX = 26;

+ + + + +

QTYPE_GPOS = 27;

+ + + + +

QTYPE_AAAA = 28;

+ + + + +

QTYPE_LOC = 29;

+ + + + +

QTYPE_NXT = 30;

+ + + + +

QTYPE_SRV = 33;

+ + + + +

QTYPE_NAPTR = 35;

+ + + + +

QTYPE_KX = 36;

+ + + + +

QTYPE_SPF = 99;

+ + + + +

QTYPE_AXFR = 252;

+ + + + +

QTYPE_MAILB = 253;

+ + + + +

QTYPE_MAILA = 254;

+ + + + +

QTYPE_ALL = 255;

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/ftpsend.TFTPList.html Index: lib/synapse/docs/help/ftpsend.TFTPList.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/ftpsend.TFTPList.html @@ -0,0 +1,169 @@ + + + + + +ftpsend: Class TFTPList + + + +

Class TFTPList

+ + +

Fields

Unit

+ftpsend

Declaration

+type TFTPList = class(TObject)

Description

+This is TList of TFTPListRec objects.

+ This object is used for holding lististing of all files information in listed directory on FTP server.

Hierarchy

TObject
TFTPList

Overview

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + +

	`constructor Create;`
	`destructor Destroy; override;`
	`procedure Clear; virtual;`
	`function Count: integer; virtual;`
	`procedure Assign(Value: TFTPList); virtual;`
	`procedure ParseLines; virtual;`

Properties

+ + + + + + + + + + + + + + + + + + + + + +

	`property List: TList read FList;`
	`property Items[Index: Integer]: TFTPListRec read GetListItem;`
	`property Lines: TStringList read FLines;`
	`property Masks: TStringList read FMasks;`
	`property UnparsedLines: TStringList read FUnparsedLines;`

Description

Methods

+ + + + + +

constructor Create;

+Constructor. You not need create this object, it is created by TFTPSend class as their property.

+ + + + + +

destructor Destroy; override;

+ + + + + +

procedure Clear; virtual;

+Clear list.

+ + + + + +

function Count: integer; virtual;

+count of holded TFTPListRec objects

+ + + + + +

procedure Assign(Value: TFTPList); virtual;

+Assigns one list to another

+ + + + + +

procedure ParseLines; virtual;

+try to parse raw directory listing in Lines to list of TFTPListRec.

Properties

+ + + + + +

property List: TList read FList;

+By this property you have access to list of TFTPListRec. This is for compatibility only. Please, use Items instead.

+ + + + + +

property Items[Index: Integer]: TFTPListRec read GetListItem;

+By this property you have access to list of TFTPListRec.

+ + + + + +

property Lines: TStringList read FLines;

+Set of lines with RAW directory listing for ParseLines

+ + + + + +

property Masks: TStringList read FMasks;

+Set of masks for directory listing parser. It is predefined by default, however you can modify it as you need. (for example, you can add your own definition mask.) Mask is same as mask used in TotalCommander.

+ + + + + +

property UnparsedLines: TStringList read FUnparsedLines;

+After ParseLines it holding lines what was not sucessfully parsed.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/ftpsend.TFTPListRec.html Index: lib/synapse/docs/help/ftpsend.TFTPListRec.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/ftpsend.TFTPListRec.html @@ -0,0 +1,147 @@ + + + + + +ftpsend: Class TFTPListRec + + + +

Class TFTPListRec

+ + +

Fields

Unit

+ftpsend

Declaration

+type TFTPListRec = class(TObject)

Description

+Object for holding file information

+ parsed from directory listing of FTP server.

Hierarchy

TObject
TFTPListRec

Overview

Methods

+ + + + + +

procedure Assign(Value: TFTPListRec); virtual;

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`property FileName: string read FFileName write FFileName;`
	`property Directory: Boolean read FDirectory write FDirectory;`
	`property Readable: Boolean read FReadable write FReadable;`
	`property FileSize: int64 read FFileSize write FFileSize;`
	`property FileTime: TDateTime read FFileTime write FFileTime;`
	`property OriginalLine: string read FOriginalLine write FOriginalLine;`
	`property Mask: string read FMask write FMask;`
	`property Permission: string read FPermission write FPermission;`

Description

Methods

+ + + + + +

procedure Assign(Value: TFTPListRec); virtual;

+You can assign another TFTPListRec to this object.

Properties

+ + + + + +

property FileName: string read FFileName write FFileName;

+name of file

+ + + + + +

property Directory: Boolean read FDirectory write FDirectory;

+if name is subdirectory not file.

+ + + + + +

property Readable: Boolean read FReadable write FReadable;

+if you have rights to read

+ + + + + +

property FileSize: int64 read FFileSize write FFileSize;

+size of file in bytes

+ + + + + +

property FileTime: TDateTime read FFileTime write FFileTime;

+date and time of file. Local server timezone is used. Any timezone conversions was not done!

+ + + + + +

property OriginalLine: string read FOriginalLine write FOriginalLine;

+original unparsed line

+ + + + + +

property Mask: string read FMask write FMask;

+mask what was used for parsing

+ + + + + +

property Permission: string read FPermission write FPermission;

+permission string (depending on used mask!)

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/ftpsend.TFTPSend.html Index: lib/synapse/docs/help/ftpsend.TFTPSend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/ftpsend.TFTPSend.html @@ -0,0 +1,714 @@ + + + + + +ftpsend: Class TFTPSend + + + +

Class TFTPSend

+ + +

Unit

+ftpsend

Declaration

+type TFTPSend = class(TSynaClient)

Description

+Implementation of FTP protocol.

+ Note: Are you missing properties for setting Username and Password? Look to parent TSynaClient object! (Username and Password have default values for "anonymous" FTP login) + +

Are you missing properties for specify server address and port? Look to parent TSynaClient too!

Hierarchy

TObject
TSynaClient
TFTPSend

Overview

Fields

+ + + + + +

CustomLogon: TLogonActions;

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`constructor Create;`
	`destructor Destroy; override;`
	`function ReadResult: Integer; virtual;`
	`procedure ParseRemote(Value: string); virtual;`
	`procedure ParseRemoteEPSV(Value: string); virtual;`
	`function FTPCommand(const Value: string): integer; virtual;`
	`function Login: Boolean; virtual;`
	`function Logout: Boolean; virtual;`
	`procedure Abort; virtual;`
	`procedure TelnetAbort; virtual;`
	`function List(Directory: string; NameList: Boolean): Boolean; virtual;`
	`function RetrieveFile(const FileName: string; Restore: Boolean): Boolean; virtual;`
	`function StoreFile(const FileName: string; Restore: Boolean): Boolean; virtual;`
	`function StoreUniqueFile: Boolean; virtual;`
	`function AppendFile(const FileName: string): Boolean; virtual;`
	`function RenameFile(const OldName, NewName: string): Boolean; virtual;`
	`function DeleteFile(const FileName: string): Boolean; virtual;`
	`function FileSize(const FileName: string): int64; virtual;`
	`function NoOp: Boolean; virtual;`
	`function ChangeWorkingDir(const Directory: string): Boolean; virtual;`
	`function ChangeToParentDir: Boolean; virtual;`
	`function ChangeToRootDir: Boolean; virtual;`
	`function DeleteDir(const Directory: string): Boolean; virtual;`
	`function CreateDir(const Directory: string): Boolean; virtual;`
	`function GetCurrentDir: String; virtual;`
	`function DataRead(const DestStream: TStream): Boolean; virtual;`
	`function DataWrite(const SourceStream: TStream): Boolean; virtual;`

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`property ResultCode: Integer read FResultCode;`
	`property ResultString: string read FResultString;`
	`property FullResult: TStringList read FFullResult;`
	`property Account: string read FAccount Write FAccount;`
	`property FWHost: string read FFWHost Write FFWHost;`
	`property FWPort: string read FFWPort Write FFWPort;`
	`property FWUsername: string read FFWUsername Write FFWUsername;`
	`property FWPassword: string read FFWPassword Write FFWPassword;`
	`property FWMode: integer read FFWMode Write FFWMode;`
	`property Sock: TTCPBlockSocket read FSock;`
	`property DSock: TTCPBlockSocket read FDSock;`
	`property DataStream: TMemoryStream read FDataStream;`
	`property DataIP: string read FDataIP;`
	`property DataPort: string read FDataPort;`
	`property DirectFile: Boolean read FDirectFile Write FDirectFile;`
	`property DirectFileName: string read FDirectFileName Write FDirectFileName;`
	`property CanResume: Boolean read FCanResume;`
	`property PassiveMode: Boolean read FPassiveMode Write FPassiveMode;`
	`property ForceDefaultPort: Boolean read FForceDefaultPort Write FForceDefaultPort;`
	`property ForceOldPort: Boolean read FForceOldPort Write FForceOldPort;`
	`property OnStatus: TFTPStatus read FOnStatus write FOnStatus;`
	`property FtpList: TFTPList read FFtpList;`
	`property BinaryMode: Boolean read FBinaryMode Write FBinaryMode;`
	`property AutoTLS: Boolean read FAutoTLS Write FAutoTLS;`
	`property FullSSL: Boolean read FFullSSL Write FFullSSL;`
	`property IsTLS: Boolean read FIsTLS;`
	`property IsDataTLS: Boolean read FIsDataTLS;`
	`property TLSonData: Boolean read FTLSonData write FTLSonData;`

Description

Fields

+ + + + + +

CustomLogon: TLogonActions;

+Custom definition of login sequence. You can use this when you set FWMode to value -1.

Methods

+ + + + + +

constructor Create;

+ + + + + +

destructor Destroy; override;

+ + + + + +

function ReadResult: Integer; virtual;

+Waits and read FTP server response. You need this only in special cases!

+ + + + + +

procedure ParseRemote(Value: string); virtual;

+Parse remote side information of data channel from value string (returned by PASV command). This function you need only in special cases!

+ + + + + +

procedure ParseRemoteEPSV(Value: string); virtual;

+Parse remote side information of data channel from value string (returned by EPSV command). This function you need only in special cases!

+ + + + + +

function FTPCommand(const Value: string): integer; virtual;

+Send Value as FTP command to FTP server. Returned result code is result of this function. This command is good for sending site specific command, or non-standard commands.

+ + + + + +

function Login: Boolean; virtual;

+Connect and logon to FTP server. If you specify any FireWall, connect to firewall and throw them connect to FTP server. Login sequence depending on FWMode.

+ + + + + +

function Logout: Boolean; virtual;

+Logoff and disconnect from FTP server.

+ + + + + +

procedure Abort; virtual;

+Break current transmission of data. (You can call this method from Sock.OnStatus event, or from another thread.)

+ + + + + +

procedure TelnetAbort; virtual;

+Break current transmission of data. It is same as Abort, but it send abort telnet commands prior ABOR FTP command. Some servers need it. (You can call this method from Sock.OnStatus event, or from another thread.)

+ + + + + +

function List(Directory: string; NameList: Boolean): Boolean; virtual;

+Download directory listing of Directory on FTP server. If Directory is empty string, download listing of current working directory. If NameList is True, download only names of files in directory. (internally use NLST command instead LIST command) If NameList is False, returned list is also parsed to FtpList property.

+ + + + + +

function RetrieveFile(const FileName: string; Restore: Boolean): Boolean; virtual;

+Read data from FileName on FTP server. If Restore is True and server supports resume dowloads, download is resumed. (received is only rest of file)

+ + + + + +

function StoreFile(const FileName: string; Restore: Boolean): Boolean; virtual;

+Send data to FileName on FTP server. If Restore is True and server supports resume upload, upload is resumed. (send only rest of file) In this case if remote file is same length as local file, nothing will be done. If remote file is larger then local, resume is disabled and file is transfered from begin!

+ + + + + +

function StoreUniqueFile: Boolean; virtual;

+Send data to FTP server and assing unique name for this file.

+ + + + + +

function AppendFile(const FileName: string): Boolean; virtual;

+Append data to FileName on FTP server.

+ + + + + +

function RenameFile(const OldName, NewName: string): Boolean; virtual;

+Rename on FTP server file with OldName to NewName.

+ + + + + +

function DeleteFile(const FileName: string): Boolean; virtual;

+Delete file FileName on FTP server.

+ + + + + +

function FileSize(const FileName: string): int64; virtual;

+Return size of Filename file on FTP server. If command failed (i.e. not implemented), return -1.

+ + + + + +

function NoOp: Boolean; virtual;

+Send NOOP command to FTP server for preserve of disconnect by inactivity timeout.

+ + + + + +

function ChangeWorkingDir(const Directory: string): Boolean; virtual;

+Change currect working directory to Directory on FTP server.

+ + + + + +

function ChangeToParentDir: Boolean; virtual;

+walk to upper directory on FTP server.

+ + + + + +

function ChangeToRootDir: Boolean; virtual;

+walk to root directory on FTP server. (May not work with all servers properly!)

+ + + + + +

function DeleteDir(const Directory: string): Boolean; virtual;

+Delete Directory on FTP server.

+ + + + + +

function CreateDir(const Directory: string): Boolean; virtual;

+Create Directory on FTP server.

+ + + + + +

function GetCurrentDir: String; virtual;

+Return current working directory on FTP server.

+ + + + + +

function DataRead(const DestStream: TStream): Boolean; virtual;

+Establish data channel to FTP server and retrieve data. This function you need only in special cases, i.e. when you need to implement some special unsupported FTP command!

+ + + + + +

function DataWrite(const SourceStream: TStream): Boolean; virtual;

+Establish data channel to FTP server and send data. This function you need only in special cases, i.e. when you need to implement some special unsupported FTP command.

Properties

+ + + + + +

property ResultCode: Integer read FResultCode;

+After FTP command contains result number of this operation.

+ + + + + +

property ResultString: string read FResultString;

+After FTP command contains main line of result.

+ + + + + +

property FullResult: TStringList read FFullResult;

+After any FTP command it contains all lines of FTP server reply.

+ + + + + +

property Account: string read FAccount Write FAccount;

+Account information used in some cases inside login sequence.

+ + + + + +

property FWHost: string read FFWHost Write FFWHost;

+Address of firewall. If empty string (default), firewall not used.

+ + + + + +

property FWPort: string read FFWPort Write FFWPort;

+port of firewall. standard value is same port as ftp server used. (21)

+ + + + + +

property FWUsername: string read FFWUsername Write FFWUsername;

+Username for login to firewall. (if needed)

+ + + + + +

property FWPassword: string read FFWPassword Write FFWPassword;

+password for login to firewall. (if needed)

+ + + + + +

property FWMode: integer read FFWMode Write FFWMode;

+Type of Firewall. Used only if you set some firewall address. Supported predefined firewall login sequences are described by comments in source file where you can see pseudocode decribing each sequence.

+ + + + + +

property Sock: TTCPBlockSocket read FSock;

+Socket object used for TCP/IP operation on control channel. Good for seting OnStatus hook, etc.

+ + + + + +

property DSock: TTCPBlockSocket read FDSock;

+Socket object used for TCP/IP operation on data channel. Good for seting OnStatus hook, etc.

+ + + + + +

property DataStream: TMemoryStream read FDataStream;

+If you not use DirectFile mode, all data transfers is made to or from this stream.

+ + + + + +

property DataIP: string read FDataIP;

+After data connection is established, contains remote side IP of this connection.

+ + + + + +

property DataPort: string read FDataPort;

+After data connection is established, contains remote side port of this connection.

+ + + + + +

property DirectFile: Boolean read FDirectFile Write FDirectFile;

+Mode of data handling by data connection. If False, all data operations are made to or from DataStream TMemoryStream. If True, data operations is made directly to file in your disk. (filename is specified by DirectFileName property.) Dafault is False!

+ + + + + +

property DirectFileName: string read FDirectFileName Write FDirectFileName;

+Filename for direct disk data operations.

+ + + + + +

property CanResume: Boolean read FCanResume;

+Indicate after Login if remote server support resume downloads and uploads.

+ + + + + +

property PassiveMode: Boolean read FPassiveMode Write FPassiveMode;

+If true (default value), all transfers is made by passive method. It is safer method for various firewalls.

+ + + + + +

property ForceDefaultPort: Boolean read FForceDefaultPort Write FForceDefaultPort;

+Force to listen for dataconnection on standard port (20). Default is False, dataconnections will be made to any non-standard port reported by PORT FTP command. This setting is not used, if you use passive mode.

+ + + + + +

property ForceOldPort: Boolean read FForceOldPort Write FForceOldPort;

+When is True, then is disabled EPSV and EPRT support. However without this commands you cannot use IPv6! (Disabling of this commands is needed only when you are behind some crap firewall/NAT.

+ + + + + +

property OnStatus: TFTPStatus read FOnStatus write FOnStatus;

+You may set this hook for monitoring FTP commands and replies.

+ + + + + +

property FtpList: TFTPList read FFtpList;

+After LIST command is here parsed list of files in given directory.

+ + + + + +

property BinaryMode: Boolean read FBinaryMode Write FBinaryMode;

+if True (default), then data transfers is in binary mode. If this is set to False, then ASCII mode is used.

+ + + + + +

property AutoTLS: Boolean read FAutoTLS Write FAutoTLS;

+if is true, then if server support upgrade to SSL/TLS mode, then use them.

+ + + + + +

property FullSSL: Boolean read FFullSSL Write FFullSSL;

+if server listen on SSL/TLS port, then you set this to true.

+ + + + + +

property IsTLS: Boolean read FIsTLS;

+Signalise, if control channel is in SSL/TLS mode.

+ + + + + +

property IsDataTLS: Boolean read FIsDataTLS;

+Signalise, if data transfers is in SSL/TLS mode.

+ + + + + +

property TLSonData: Boolean read FTLSonData write FTLSonData;

+If True (default), then try to use SSL/TLS on data transfers too. If False, then SSL/TLS is used only for control connection.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/ftpsend.html Index: lib/synapse/docs/help/ftpsend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/ftpsend.html @@ -0,0 +1,137 @@ + + + + + +ftpsend + + + +

Unit ftpsend

+ + +

Variables

Description

uses

SysUtils
Classes
blcksock
synautil
synaip
synsock

Overview

Classes, Interfaces, Objects and Records

+ + + + + + + + + + + + + + + + + +

Name	Description
Class `TFTPListRec`	Object for holding file information
Class `TFTPList`	This is TList of TFTPListRec objects.
Class `TFTPSend`	Implementation of FTP protocol.

Functions and Procedures

+ + + + + + + + + + +

function FtpGetFile(const IP, Port, FileName, LocalFile, User, Pass: string): Boolean;

function FtpPutFile(const IP, Port, FileName, LocalFile, User, Pass: string): Boolean;

function FtpInterServerTransfer( const FromIP, FromPort, FromFile, FromUser, FromPass: string; const ToIP, ToPort, ToFile, ToUser, ToPass: string): Boolean;

Types

+ + + + + + + +

TLogonActions = array [0..17] of byte;

TFTPStatus = procedure(Sender: TObject; Response: Boolean; const Value: string) of object;

Constants

+ + + + + + + + + + + + + +

cFtpProtocol = '21';

cFtpDataProtocol = '20';

FTP_OK = 255;

FTP_ERR = 254;

Description

Functions and Procedures

+ + + + +

function FtpGetFile(const IP, Port, FileName, LocalFile, User, Pass: string): Boolean;

+A very useful function, and example of use can be found in the TFtpSend object. Dowload specified file from FTP server to LocalFile.

+ + + + +

function FtpPutFile(const IP, Port, FileName, LocalFile, User, Pass: string): Boolean;

+A very useful function, and example of use can be found in the TFtpSend object. Upload specified LocalFile to FTP server.

+ + + + +

function FtpInterServerTransfer( const FromIP, FromPort, FromFile, FromUser, FromPass: string; const ToIP, ToPort, ToFile, ToUser, ToPass: string): Boolean;

+A very useful function, and example of use can be found in the TFtpSend object. Initiate transfer of file between two FTP servers.

Types

+ + + + +

TLogonActions = array [0..17] of byte;

+Array for holding definition of logon sequence.

+ + + + +

TFTPStatus = procedure(Sender: TObject; Response: Boolean; const Value: string) of object;

+Procedural type for OnStatus event. Sender is calling TFTPSend object. Value is FTP command or reply to this comand. (if it is reply, Response is True).

Constants

+ + + + +

cFtpProtocol = '21';

+ + + + +

cFtpDataProtocol = '20';

+ + + + +

FTP_OK = 255;

+Terminating value for TLogonActions

+ + + + +

FTP_ERR = 254;

+Terminating value for TLogonActions

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/ftptsend.TTFTPSend.html Index: lib/synapse/docs/help/ftptsend.TTFTPSend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/ftptsend.TTFTPSend.html @@ -0,0 +1,192 @@ + + + + + +ftptsend: Class TTFTPSend + + + +

Class TTFTPSend

+ + +

Fields

Unit

+ftptsend

Declaration

+type TTFTPSend = class(TSynaClient)

Description

+Implementation of TFTP client and server

+ Note: Are you missing properties for specify server address and port? Look to parent TSynaClient too!

Hierarchy

TObject
TSynaClient
TTFTPSend

Overview

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`constructor Create;`
	`destructor Destroy; override;`
	`function SendFile(const Filename: string): Boolean;`
	`function RecvFile(const Filename: string): Boolean;`
	`function WaitForRequest(var Req: word; var filename: string): Boolean;`
	`procedure ReplyError(Error: word; Description: string);`
	`function ReplyRecv: Boolean;`
	`function ReplySend: Boolean;`

Properties

+ + + + + + + + + + + + + + + + + + + + + +

	`property ErrorCode: integer read FErrorCode;`
	`property ErrorString: string read FErrorString;`
	`property Data: TMemoryStream read FData;`
	`property RequestIP: string read FRequestIP write FRequestIP;`
	`property RequestPort: string read FRequestPort write FRequestPort;`

Description

Methods

+ + + + + +

constructor Create;

+ + + + + +

destructor Destroy; override;

+ + + + + +

function SendFile(const Filename: string): Boolean;

+Upload Data as file to TFTP server.

+ + + + + +

function RecvFile(const Filename: string): Boolean;

+Download file from TFTP server to Data.

+ + + + + +

function WaitForRequest(var Req: word; var filename: string): Boolean;

+Acts as TFTP server and wait for client request. When some request incoming within Timeout, result is True and parametres is filled with information from request. You must handle this request, validate it, and call ReplyError, ReplyRecv or ReplySend for send reply to TFTP Client.

+ + + + + +

procedure ReplyError(Error: word; Description: string);

+send error to TFTP client, when you acts as TFTP server.

+ + + + + +

function ReplyRecv: Boolean;

+Accept uploaded file from TFTP client to Data, when you acts as TFTP server.

+ + + + + +

function ReplySend: Boolean;

+Accept download request file from TFTP client and send content of Data, when you acts as TFTP server.

Properties

+ + + + + +

property ErrorCode: integer read FErrorCode;

+Code of TFTP error.

+ + + + + +

property ErrorString: string read FErrorString;

+Human readable decription of TFTP error. (if is sended by remote side)

+ + + + + +

property Data: TMemoryStream read FData;

+MemoryStream with datas for sending or receiving

+ + + + + +

property RequestIP: string read FRequestIP write FRequestIP;

+Address of TFTP remote side.

+ + + + + +

property RequestPort: string read FRequestPort write FRequestPort;

+Port of TFTP remote side.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/ftptsend.html Index: lib/synapse/docs/help/ftptsend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/ftptsend.html @@ -0,0 +1,89 @@ + + + + + +ftptsend + + + +

Unit ftptsend

+ + +

Functions and Procedures

Types

Variables

Description

+TFTP client and server protocol

+ + +

Used RFC: RFC-1350

uses

SysUtils
Classes
blcksock
synautil

Overview

Classes, Interfaces, Objects and Records

+ + + + + + + + + +

Name	Description
Class `TTFTPSend`	Implementation of TFTP client and server

Constants

+ + + + + + + + + + + + + + + + + + + +

cTFTPProtocol = '69';

cTFTP_RRQ = word(1);

cTFTP_WRQ = word(2);

cTFTP_DTA = word(3);

cTFTP_ACK = word(4);

cTFTP_ERR = word(5);

Description

Constants

+ + + + +

cTFTPProtocol = '69';

+ + + + +

cTFTP_RRQ = word(1);

+ + + + +

cTFTP_WRQ = word(2);

+ + + + +

cTFTP_DTA = word(3);

+ + + + +

cTFTP_ACK = word(4);

+ + + + +

cTFTP_ERR = word(5);

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/httpsend.THTTPSend.html Index: lib/synapse/docs/help/httpsend.THTTPSend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/httpsend.THTTPSend.html @@ -0,0 +1,360 @@ + + + + + +httpsend: Class THTTPSend + + + +

Class THTTPSend

+ + +

Fields

Unit

+httpsend

Declaration

+type THTTPSend = class(TSynaClient)

Description

+abstract(Implementation of HTTP protocol.)

Hierarchy

TObject
TSynaClient
THTTPSend

Overview

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + +

	`constructor Create;`
	`destructor Destroy; override;`
	`procedure Clear;`
	`procedure DecodeStatus(const Value: string);`
	`function HTTPMethod(const Method, URL: string): Boolean;`
	`procedure Abort;`

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`property Headers: TStringList read FHeaders;`
	`property Cookies: TStringList read FCookies;`
	`property Document: TMemoryStream read FDocument;`
	`property RangeStart: integer read FRangeStart Write FRangeStart;`
	`property RangeEnd: integer read FRangeEnd Write FRangeEnd;`
	`property MimeType: string read FMimeType Write FMimeType;`
	`property Protocol: string read FProtocol Write FProtocol;`
	`property KeepAlive: Boolean read FKeepAlive Write FKeepAlive;`
	`property KeepAliveTimeout: integer read FKeepAliveTimeout Write FKeepAliveTimeout;`
	`property Status100: Boolean read FStatus100 Write FStatus100;`
	`property ProxyHost: string read FProxyHost Write FProxyHost;`
	`property ProxyPort: string read FProxyPort Write FProxyPort;`
	`property ProxyUser: string read FProxyUser Write FProxyUser;`
	`property ProxyPass: string read FProxyPass Write FProxyPass;`
	`property UserAgent: string read FUserAgent Write FUserAgent;`
	`property ResultCode: Integer read FResultCode;`
	`property ResultString: string read FResultString;`
	`property DownloadSize: integer read FDownloadSize;`
	`property UploadSize: integer read FUploadSize;`
	`property Sock: TTCPBlockSocket read FSock;`
	`property AddPortNumberToHost: Boolean read FAddPortNumberToHost write FAddPortNumberToHost;`

Description

Methods

+ + + + + +

constructor Create;

+ + + + + +

destructor Destroy; override;

+ + + + + +

procedure Clear;

+Reset headers and document and Mimetype.

+ + + + + +

procedure DecodeStatus(const Value: string);

+Decode ResultCode and ResultString from Value.

+ + + + + +

function HTTPMethod(const Method, URL: string): Boolean;

+Connects to host define in URL and access to resource defined in URL by method. If Document is not empty, send it to server as part of HTTP request. Server response is in Document and headers. Connection may be authorised by username and password in URL. If you define proxy properties, connection is made by this proxy. If all OK, result is True, else result is False. + +

+ + + + + +

procedure Abort;

+You can call this method from OnStatus event for break current data transfer. (or from another thread.)

Properties

+ + + + + +

property Headers: TStringList read FHeaders;

+Before HTTP operation you may define any non-standard headers for HTTP request, except of: 'Expect: 100-continue', 'Content-Length', 'Content-Type', 'Connection', 'Authorization', 'Proxy-Authorization' and 'Host' headers. After HTTP operation contains full headers of returned document.

+ + + + + +

property Cookies: TStringList read FCookies;

+This is stringlist with name-value stringlist pairs. Each this pair is one cookie. After HTTP request is returned cookies parsed to this stringlist. You can leave this cookies untouched for next HTTP request. You can also save this stringlist for later use.

+ + + + + +

property Document: TMemoryStream read FDocument;

+Stream with document to send (before request, or with document received from HTTP server (after request).

+ + + + + +

property RangeStart: integer read FRangeStart Write FRangeStart;

+If you need download only part of requested document, here specify possition of subpart begin. If here 0, then is requested full document.

+ + + + + +

property RangeEnd: integer read FRangeEnd Write FRangeEnd;

+If you need download only part of requested document, here specify possition of subpart end. If here 0, then is requested document from rangeStart to end of document. (for broken download restoration, for example.)

+ + + + + +

property MimeType: string read FMimeType Write FMimeType;

+Mime type of sending data. Default is: 'text/html'.

+ + + + + +

property Protocol: string read FProtocol Write FProtocol;

+Define protocol version. Possible values are: '1.1', '1.0' (default) and '0.9'.

+ + + + + +

property KeepAlive: Boolean read FKeepAlive Write FKeepAlive;

+If True (default value), keepalives in HTTP protocol 1.1 is enabled.

+ + + + + +

property KeepAliveTimeout: integer read FKeepAliveTimeout Write FKeepAliveTimeout;

+Define timeout for keepalives in seconds!

+ + + + + +

property Status100: Boolean read FStatus100 Write FStatus100;

+if True, then server is requested for 100status capability when uploading data. Default is False (off).

+ + + + + +

property ProxyHost: string read FProxyHost Write FProxyHost;

+Address of proxy server (IP address or domain name) where you want to connect in HTTPMethod method.

+ + + + + +

property ProxyPort: string read FProxyPort Write FProxyPort;

+Port number for proxy connection. Default value is 8080.

+ + + + + +

property ProxyUser: string read FProxyUser Write FProxyUser;

+Username for connect to proxy server where you want to connect in HTTPMethod method.

+ + + + + +

property ProxyPass: string read FProxyPass Write FProxyPass;

+Password for connect to proxy server where you want to connect in HTTPMethod method.

+ + + + + +

property UserAgent: string read FUserAgent Write FUserAgent;

+Here you can specify custom User-Agent indentification. By default is used: 'Mozilla/4.0 (compatible; Synapse)'

+ + + + + +

property ResultCode: Integer read FResultCode;

+After successful HTTPMethod method contains result code of operation.

+ + + + + +

property ResultString: string read FResultString;

+After successful HTTPMethod method contains string after result code.

+ + + + + +

property DownloadSize: integer read FDownloadSize;

+if this value is not 0, then data download pending. In this case you have here total sice of downloaded data. It is good for draw download progressbar from OnStatus event.

+ + + + + +

property UploadSize: integer read FUploadSize;

+if this value is not 0, then data upload pending. In this case you have here total sice of uploaded data. It is good for draw upload progressbar from OnStatus event.

+ + + + + +

property Sock: TTCPBlockSocket read FSock;

+Socket object used for TCP/IP operation. Good for seting OnStatus hook, etc.

+ + + + + +

property AddPortNumberToHost: Boolean read FAddPortNumberToHost write FAddPortNumberToHost;

+To have possibility to switch off port number in 'Host:' HTTP header, by default True. Some buggy servers not like port informations in this header.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/httpsend.html Index: lib/synapse/docs/help/httpsend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/httpsend.html @@ -0,0 +1,119 @@ + + + + + +httpsend + + + +

Unit httpsend

+ + +

Variables

Description

uses

SysUtils
Classes
blcksock
synautil
synaip
synacode
synsock

Overview

Classes, Interfaces, Objects and Records

+ + + + + + + + + +

Name	Description
Class `THTTPSend`

Functions and Procedures

+ + + + + + + + + + + + + + + + +

function HttpGetText(const URL: string; const Response: TStrings): Boolean;

function HttpGetBinary(const URL: string; const Response: TStream): Boolean;

function HttpPostBinary(const URL: string; const Data: TStream): Boolean;

function HttpPostURL(const URL, URLData: string; const Data: TStream): Boolean;

function HttpPostFile(const URL, FieldName, FileName: string; const Data: TStream; const ResultData: TStrings): Boolean;

Types

+ + + + +

TTransferEncoding = (...);

Constants

+ + + + +

cHttpProtocol = '80';

Description

Functions and Procedures

+ + + + +

function HttpGetText(const URL: string; const Response: TStrings): Boolean;

+A very usefull function, and example of use can be found in the THTTPSend object. It implements the GET method of the HTTP protocol. This function sends the GET method for URL document to an HTTP server. Returned document is in the "Response" stringlist (without any headers). Returns boolean TRUE if all went well.

+ + + + +

function HttpGetBinary(const URL: string; const Response: TStream): Boolean;

+ + + + +

function HttpPostBinary(const URL: string; const Data: TStream): Boolean;

+A very useful function, and example of use can be found in the THTTPSend object. It implements the POST method of the HTTP protocol. This function sends the SEND method for a URL document to an HTTP server. The document to be sent is located in "Data" stream. The returned document is in the "Data" stream. Returns boolean TRUE if all went well.

+ + + + +

function HttpPostURL(const URL, URLData: string; const Data: TStream): Boolean;

+A very useful function, and example of use can be found in the THTTPSend object. It implements the POST method of the HTTP protocol. This function is good for POSTing form data. It sends the POST method for a URL document to an HTTP server. You must prepare the form data in the same manner as you would the URL data, and pass this prepared data to "URLdata". The following is a sample of how the data would appear: 'name=Lukas&field1=some%20data'. The information in the field must be encoded by EncodeURLElement function. The returned document is in the "Data" stream. Returns boolean TRUE if all went well.

+ + + + +

function HttpPostFile(const URL, FieldName, FileName: string; const Data: TStream; const ResultData: TStrings): Boolean;

+A very useful function, and example of use can be found in the THTTPSend object. It implements the POST method of the HTTP protocol. This function sends the POST method for a URL document to an HTTP server. This function simulate posting of file by HTML form used method 'multipart/form-data'. Posting file is in DATA stream. Its name is Filename string. Fieldname is for name of formular field with file. (simulate HTML INPUT FILE) The returned document is in the ResultData Stringlist. Returns boolean TRUE if all went well.

Types

+ + + + +

TTransferEncoding = (...);

+These encoding types are used internally by the THTTPSend object to identify the transfer data types.

+TE_UNKNOWN:
+TE_IDENTITY:
+TE_CHUNKED:

Constants

+ + + + +

cHttpProtocol = '80';

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/imapsend.TIMAPSend.html Index: lib/synapse/docs/help/imapsend.TIMAPSend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/imapsend.TIMAPSend.html @@ -0,0 +1,626 @@ + + + + + +imapsend: Class TIMAPSend + + + +

Class TIMAPSend

+ + +

Fields

Unit

+imapsend

Declaration

+type TIMAPSend = class(TSynaClient)

Description

+Implementation of IMAP4 protocol.

+ Note: Are you missing properties for setting Username and Password? Look to parent TSynaClient object! + +

Are you missing properties for specify server address and port? Look to parent TSynaClient too!

Hierarchy

TObject
TSynaClient
TIMAPSend

Overview

Methods

	`constructor Create;`
	`destructor Destroy; override;`
	`function IMAPcommand(Value: string): string;`
	`function IMAPuploadCommand(Value: string; const Data:TStrings): string;`
	`function Capability: Boolean;`
	`function Login: Boolean;`
	`function Logout: Boolean;`
	`function NoOp: Boolean;`
	`function List(FromFolder: string; const FolderList: TStrings): Boolean;`
	`function ListSearch(FromFolder, Search: string; const FolderList: TStrings): Boolean;`
	`function ListSubscribed(FromFolder: string; const FolderList: TStrings): Boolean;`
	`function ListSearchSubscribed(FromFolder, Search: string; const FolderList: TStrings): Boolean;`
	`function CreateFolder(FolderName: string): Boolean;`
	`function DeleteFolder(FolderName: string): Boolean;`
	`function RenameFolder(FolderName, NewFolderName: string): Boolean;`
	`function SubscribeFolder(FolderName: string): Boolean;`
	`function UnsubscribeFolder(FolderName: string): Boolean;`
	`function SelectFolder(FolderName: string): Boolean;`
	`function SelectROFolder(FolderName: string): Boolean;`
	`function CloseFolder: Boolean;`
	`function StatusFolder(FolderName, Value: string): integer;`
	`function ExpungeFolder: Boolean;`
	`function CheckFolder: Boolean;`
	`function AppendMess(ToFolder: string; const Mess: TStrings): Boolean;`
	`function DeleteMess(MessID: integer): boolean;`
	`function FetchMess(MessID: integer; const Mess: TStrings): Boolean;`
	`function FetchHeader(MessID: integer; const Headers: TStrings): Boolean;`
	`function MessageSize(MessID: integer): integer;`
	`function CopyMess(MessID: integer; ToFolder: string): Boolean;`
	`function SearchMess(Criteria: string; const FoundMess: TStrings): Boolean;`
	`function SetFlagsMess(MessID: integer; Flags: string): Boolean;`
	`function GetFlagsMess(MessID: integer; var Flags: string): Boolean;`
	`function AddFlagsMess(MessID: integer; Flags: string): Boolean;`
	`function DelFlagsMess(MessID: integer; Flags: string): Boolean;`
	`function StartTLS: Boolean;`
	`function GetUID(MessID: integer; var UID : Integer): Boolean;`
	`function FindCap(const Value: string): string;`

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`property ResultString: string read FResultString;`
	`property FullResult: TStringList read FFullResult;`
	`property IMAPcap: TStringList read FIMAPcap;`
	`property AuthDone: Boolean read FAuthDone;`
	`property UID: Boolean read FUID Write FUID;`
	`property SelectedFolder: string read FSelectedFolder;`
	`property SelectedCount: integer read FSelectedCount;`
	`property SelectedRecent: integer read FSelectedRecent;`
	`property SelectedUIDvalidity: integer read FSelectedUIDvalidity;`
	`property AutoTLS: Boolean read FAutoTLS Write FAutoTLS;`
	`property FullSSL: Boolean read FFullSSL Write FFullSSL;`
	`property Sock: TTCPBlockSocket read FSock;`

Description

Methods

+ + + + + +

constructor Create;

+ + + + + +

destructor Destroy; override;

+ + + + + +

function IMAPcommand(Value: string): string;

+By this function you can call any IMAP command. Result of this command is in adequate properties.

+ + + + + +

function IMAPuploadCommand(Value: string; const Data:TStrings): string;

+By this function you can call any IMAP command what need upload any data. Result of this command is in adequate properties.

+ + + + + +

function Capability: Boolean;

+Call CAPABILITY command and fill IMAPcap property by new values.

+ + + + + +

function Login: Boolean;

+Connect to IMAP server and do login to this server. This command begin session.

+ + + + + +

function Logout: Boolean;

+Disconnect from IMAP server and terminate session session. If exists some deleted and non-purged messages, these messages are not deleted!

+ + + + + +

function NoOp: Boolean;

+Do NOOP. It is for prevent disconnect by timeout.

+ + + + + +

function List(FromFolder: string; const FolderList: TStrings): Boolean;

+Lists folder names. You may specify level of listing. If you specify FromFolder as empty string, return is all folders in system.

+ + + + + +

function ListSearch(FromFolder, Search: string; const FolderList: TStrings): Boolean;

+Lists folder names what match search criteria. You may specify level of listing. If you specify FromFolder as empty string, return is all folders in system.

+ + + + + +

function ListSubscribed(FromFolder: string; const FolderList: TStrings): Boolean;

+Lists subscribed folder names. You may specify level of listing. If you specify FromFolder as empty string, return is all subscribed folders in system.

+ + + + + +

function ListSearchSubscribed(FromFolder, Search: string; const FolderList: TStrings): Boolean;

+Lists subscribed folder names what matching search criteria. You may specify level of listing. If you specify FromFolder as empty string, return is all subscribed folders in system.

+ + + + + +

function CreateFolder(FolderName: string): Boolean;

+Create a new folder.

+ + + + + +

function DeleteFolder(FolderName: string): Boolean;

+Delete a folder.

+ + + + + +

function RenameFolder(FolderName, NewFolderName: string): Boolean;

+Rename folder names.

+ + + + + +

function SubscribeFolder(FolderName: string): Boolean;

+Subscribe folder.

+ + + + + +

function UnsubscribeFolder(FolderName: string): Boolean;

+Unsubscribe folder.

+ + + + + +

function SelectFolder(FolderName: string): Boolean;

+Select folder.

+ + + + + +

function SelectROFolder(FolderName: string): Boolean;

+Select folder, but only for reading. Any changes are not allowed!

+ + + + + +

function CloseFolder: Boolean;

+Close a folder. (end of Selected state)

+ + + + + +

function StatusFolder(FolderName, Value: string): integer;

+Ask for given status of folder. I.e. if you specify as value 'UNSEEN', result is number of unseen messages in folder. For another status indentificator check IMAP documentation and documentation of your IMAP server (each IMAP server can have their own statuses.)

+ + + + + +

function ExpungeFolder: Boolean;

+Hardly delete all messages marked as 'deleted' in current selected folder.

+ + + + + +

function CheckFolder: Boolean;

+Touch to folder. (use as update status of folder, etc.)

+ + + + + +

function AppendMess(ToFolder: string; const Mess: TStrings): Boolean;

+Append given message to specified folder.

+ + + + + +

function DeleteMess(MessID: integer): boolean;

+'Delete' message from current selected folder. It mark message as Deleted. Real deleting will be done after sucessfull CloseFolder or ExpungeFolder

+ + + + + +

function FetchMess(MessID: integer; const Mess: TStrings): Boolean;

+Get full message from specified message in selected folder.

+ + + + + +

function FetchHeader(MessID: integer; const Headers: TStrings): Boolean;

+Get message headers only from specified message in selected folder.

+ + + + + +

function MessageSize(MessID: integer): integer;

+Return message size of specified message from current selected folder.

+ + + + + +

function CopyMess(MessID: integer; ToFolder: string): Boolean;

+Copy message from current selected folder to another folder.

+ + + + + +

function SearchMess(Criteria: string; const FoundMess: TStrings): Boolean;

+Return message numbers from currently selected folder as result of searching. Search criteria is very complex language (see to IMAP specification) similar to SQL (but not same syntax!).

+ + + + + +

function SetFlagsMess(MessID: integer; Flags: string): Boolean;

+Sets flags of message from current selected folder.

+ + + + + +

function GetFlagsMess(MessID: integer; var Flags: string): Boolean;

+Gets flags of message from current selected folder.

+ + + + + +

function AddFlagsMess(MessID: integer; Flags: string): Boolean;

+Add flags to message's flags.

+ + + + + +

function DelFlagsMess(MessID: integer; Flags: string): Boolean;

+Remove flags from message's flags.

+ + + + + +

function StartTLS: Boolean;

+Call STARTTLS command for upgrade connection to SSL/TLS mode.

+ + + + + +

function GetUID(MessID: integer; var UID : Integer): Boolean;

+return UID of requested message ID.

+ + + + + +

function FindCap(const Value: string): string;

+Try to find given capabily in capabilty string returned from IMAP server.

Properties

+ + + + + +

property ResultString: string read FResultString;

+Status line with result of last operation.

+ + + + + +

property FullResult: TStringList read FFullResult;

+Full result of last IMAP operation.

+ + + + + +

property IMAPcap: TStringList read FIMAPcap;

+List of server capabilites.

+ + + + + +

property AuthDone: Boolean read FAuthDone;

+Authorization is successful done.

+ + + + + +

property UID: Boolean read FUID Write FUID;

+Turn on or off usage of UID (unicate identificator) of messages instead only sequence numbers.

+ + + + + +

property SelectedFolder: string read FSelectedFolder;

+Name of currently selected folder.

+ + + + + +

property SelectedCount: integer read FSelectedCount;

+Count of messages in currently selected folder.

+ + + + + +

property SelectedRecent: integer read FSelectedRecent;

+Count of not-visited messages in currently selected folder.

+ + + + + +

property SelectedUIDvalidity: integer read FSelectedUIDvalidity;

+This number with name of folder is unique indentificator of folder. (If someone delete folder and next create new folder with exactly same name of folder, this number is must be different!)

+ + + + + +

property AutoTLS: Boolean read FAutoTLS Write FAutoTLS;

+If is set to true, then upgrade to SSL/TLS mode if remote server support it.

+ + + + + +

property FullSSL: Boolean read FFullSSL Write FFullSSL;

+SSL/TLS mode is used from first contact to server. Servers with full SSL/TLS mode usualy using non-standard TCP port!

+ + + + + +

property Sock: TTCPBlockSocket read FSock;

+Socket object used for TCP/IP operation. Good for seting OnStatus hook, etc.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/imapsend.html Index: lib/synapse/docs/help/imapsend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/imapsend.html @@ -0,0 +1,49 @@ + + + + + +imapsend + + + +

Unit imapsend

+ + +

Functions and Procedures

Types

Variables

Description

+IMAP4 rev1 protocol client

+ + +

Used RFC: RFC-2060, RFC-2595

uses

SysUtils
Classes
blcksock
synautil

Overview

Classes, Interfaces, Objects and Records

+ + + + + + + + + +

Name	Description
Class `TIMAPSend`	Implementation of IMAP4 protocol.

Constants

+ + + + +

cIMAPProtocol = '143';

Description

Constants

+ + + + +

cIMAPProtocol = '143';

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:50 + + ADDED lib/synapse/docs/help/index.html Index: lib/synapse/docs/help/index.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/index.html @@ -0,0 +1,8 @@ + + + + + + + + ADDED lib/synapse/docs/help/laz_synapse.html Index: lib/synapse/docs/help/laz_synapse.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/laz_synapse.html @@ -0,0 +1,18 @@ + + + + + +laz_synapse + + + +

Unit laz_synapse

+ + +

Classes, Interfaces, Objects and Records

Functions and Procedures

Types

Constants

Variables

Description

uses

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/ldapsend.TLDAPAttribute.html Index: lib/synapse/docs/help/ldapsend.TLDAPAttribute.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/ldapsend.TLDAPAttribute.html @@ -0,0 +1,59 @@ + + + + + +ldapsend: Class TLDAPAttribute + + + +

Class TLDAPAttribute

+ + +

Fields

Methods

Properties

Unit

Declaration

+type TLDAPAttribute = class(TStringList)

Description

+LDAP attribute with list of their values

+ This class holding name of LDAP attribute and list of their values. This is descendant of TStringList class enhanced by some new properties.

Hierarchy

TStringList
TLDAPAttribute

Overview

Properties

+ + + + + + + + + +

	`property AttributeName: AnsiString read FAttributeName Write SetAttributeName;`
	`property IsBinary: Boolean read FIsBinary;`

Description

Properties

+ + + + + +

property AttributeName: AnsiString read FAttributeName Write SetAttributeName;

+Name of LDAP attribute.

+ + + + + +

property IsBinary: Boolean read FIsBinary;

+Return True when attribute contains binary data.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/ldapsend.TLDAPAttributeList.html Index: lib/synapse/docs/help/ldapsend.TLDAPAttributeList.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/ldapsend.TLDAPAttributeList.html @@ -0,0 +1,143 @@ + + + + + +ldapsend: Class TLDAPAttributeList + + + +

Class TLDAPAttributeList

+ + +

Fields

Unit

Declaration

+type TLDAPAttributeList = class(TObject)

Description

+List of TLDAPAttribute

+ This object can hold list of TLDAPAttribute objects.

Hierarchy

TObject
TLDAPAttributeList

Overview

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`constructor Create;`
	`destructor Destroy; override;`
	`procedure Clear;`
	`function Count: integer;`
	`function Add: TLDAPAttribute;`
	`procedure Del(Index: integer);`
	`function Find(AttributeName: AnsiString): TLDAPAttribute;`
	`function Get(AttributeName: AnsiString): string;`

Properties

+ + + + + +

property Items[Index: Integer]: TLDAPAttribute read GetAttribute;

Description

Methods

+ + + + + +

constructor Create;

+ + + + + +

destructor Destroy; override;

+ + + + + +

procedure Clear;

+Clear list.

+ + + + + +

function Count: integer;

+Return count of TLDAPAttribute objects in list.

+ + + + + +

function Add: TLDAPAttribute;

+Add new TLDAPAttribute object to list.

+ + + + + +

procedure Del(Index: integer);

+Delete one TLDAPAttribute object from list.

+ + + + + +

function Find(AttributeName: AnsiString): TLDAPAttribute;

+Find and return attribute with requested name. Returns nil if not found.

+ + + + + +

function Get(AttributeName: AnsiString): string;

+Find and return attribute value with requested name. Returns empty string if not found.

Properties

+ + + + + +

property Items[Index: Integer]: TLDAPAttribute read GetAttribute;

+List of TLDAPAttribute objects.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/ldapsend.TLDAPResult.html Index: lib/synapse/docs/help/ldapsend.TLDAPResult.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/ldapsend.TLDAPResult.html @@ -0,0 +1,83 @@ + + + + + +ldapsend: Class TLDAPResult + + + +

Class TLDAPResult

+ + +

Fields

Unit

Declaration

+type TLDAPResult = class(TObject)

Description

+LDAP result object

+ This object can hold LDAP object. (their name and all their attributes with values)

Hierarchy

TObject
TLDAPResult

Overview

Methods

+ + + + + + + + + +

	`constructor Create;`
	`destructor Destroy; override;`

Properties

+ + + + + + + + + +

	`property ObjectName: AnsiString read FObjectName write FObjectName;`
	`property Attributes: TLDAPAttributeList read FAttributes;`

Description

Methods

+ + + + + +

constructor Create;

+ + + + + +

destructor Destroy; override;

Properties

+ + + + + +

property ObjectName: AnsiString read FObjectName write FObjectName;

+Name of this LDAP object.

+ + + + + +

property Attributes: TLDAPAttributeList read FAttributes;

+Here is list of object attributes.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/ldapsend.TLDAPResultList.html Index: lib/synapse/docs/help/ldapsend.TLDAPResultList.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/ldapsend.TLDAPResultList.html @@ -0,0 +1,107 @@ + + + + + +ldapsend: Class TLDAPResultList + + + +

Class TLDAPResultList

+ + +

Fields

Unit

Declaration

+type TLDAPResultList = class(TObject)

Description

+List of LDAP result objects

+ This object can hold list of LDAP objects. (for example result of LDAP SEARCH.)

Hierarchy

TObject
TLDAPResultList

Overview

Methods

+ + + + + + + + + + + + + + + + + + + + + +

	`constructor Create;`
	`destructor Destroy; override;`
	`procedure Clear;`
	`function Count: integer;`
	`function Add: TLDAPResult;`

Properties

+ + + + + +

property Items[Index: Integer]: TLDAPResult read GetResult;

Description

Methods

+ + + + + +

constructor Create;

+ + + + + +

destructor Destroy; override;

+ + + + + +

procedure Clear;

+Clear all TLDAPResult objects in list.

+ + + + + +

function Count: integer;

+Return count of TLDAPResult objects in list.

+ + + + + +

function Add: TLDAPResult;

+Create and add new TLDAPResult object to list.

Properties

+ + + + + +

property Items[Index: Integer]: TLDAPResult read GetResult;

+List of TLDAPResult objects.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/ldapsend.TLDAPSend.html Index: lib/synapse/docs/help/ldapsend.TLDAPSend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/ldapsend.TLDAPSend.html @@ -0,0 +1,404 @@ + + + + + +ldapsend: Class TLDAPSend + + + +

Class TLDAPSend

+ + +

Fields

Unit

Declaration

+type TLDAPSend = class(TSynaClient)

Description

+Implementation of LDAP client

+ (version 2 and 3) + +

Note: Are you missing properties for setting Username and Password? Look to parent TSynaClient object! + +

Are you missing properties for specify server address and port? Look to parent TSynaClient too!

Hierarchy

TObject
TSynaClient
TLDAPSend

Overview

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`constructor Create;`
	`destructor Destroy; override;`
	`function Login: Boolean;`
	`function Bind: Boolean;`
	`function BindSasl: Boolean;`
	`function Logout: Boolean;`
	`function Modify(obj: AnsiString; Op: TLDAPModifyOp; const Value: TLDAPAttribute): Boolean;`
	`function Add(obj: AnsiString; const Value: TLDAPAttributeList): Boolean;`
	`function Delete(obj: AnsiString): Boolean;`
	`function ModifyDN(obj, newRDN, newSuperior: AnsiString; DeleteoldRDN: Boolean): Boolean;`
	`function Compare(obj, AttributeValue: AnsiString): Boolean;`
	`function Search(obj: AnsiString; TypesOnly: Boolean; Filter: AnsiString; const Attributes: TStrings): Boolean;`
	`function Extended(const Name, Value: AnsiString): Boolean;`
	`function StartTLS: Boolean;`

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`property Version: integer read FVersion Write FVersion;`
	`property ResultCode: Integer read FResultCode;`
	`property ResultString: AnsiString read FResultString;`
	`property FullResult: AnsiString read FFullResult;`
	`property AutoTLS: Boolean read FAutoTLS Write FAutoTLS;`
	`property FullSSL: Boolean read FFullSSL Write FFullSSL;`
	`property Seq: integer read FSeq;`
	`property SearchScope: TLDAPSearchScope read FSearchScope Write FSearchScope;`
	`property SearchAliases: TLDAPSearchAliases read FSearchAliases Write FSearchAliases;`
	`property SearchSizeLimit: integer read FSearchSizeLimit Write FSearchSizeLimit;`
	`property SearchTimeLimit: integer read FSearchTimeLimit Write FSearchTimeLimit;`
	`property SearchResult: TLDAPResultList read FSearchResult;`
	`property Referals: TStringList read FReferals;`
	`property ExtName: AnsiString read FExtName;`
	`property ExtValue: AnsiString read FExtValue;`
	`property Sock: TTCPBlockSocket read FSock;`

Description

Methods

+ + + + + +

constructor Create;

+ + + + + +

destructor Destroy; override;

+ + + + + +

function Login: Boolean;

+Try to connect to LDAP server and start secure channel, when it is required.

+ + + + + +

function Bind: Boolean;

+Try to bind to LDAP server with TSynaClient.UserName and TSynaClient.Password. If this is empty strings, then it do annonymous Bind. When you not call Bind on LDAPv3, then is automaticly used anonymous mode. + +

This method using plaintext transport of password! It is not secure!

+ + + + + +

function BindSasl: Boolean;

This method using SASL with DIGEST-MD5 method for secure transfer of your password.

+ + + + + +

function Logout: Boolean;

+Close connection to LDAP server.

+ + + + + +

function Modify(obj: AnsiString; Op: TLDAPModifyOp; const Value: TLDAPAttribute): Boolean;

+Modify content of LDAP attribute on this object.

+ + + + + +

function Add(obj: AnsiString; const Value: TLDAPAttributeList): Boolean;

+Add list of attributes to specified object.

+ + + + + +

function Delete(obj: AnsiString): Boolean;

+Delete this LDAP object from server.

+ + + + + +

function ModifyDN(obj, newRDN, newSuperior: AnsiString; DeleteoldRDN: Boolean): Boolean;

+Modify object name of this LDAP object.

+ + + + + +

function Compare(obj, AttributeValue: AnsiString): Boolean;

+Try to compare Attribute value with this LDAP object.

+ + + + + +

function Search(obj: AnsiString; TypesOnly: Boolean; Filter: AnsiString; const Attributes: TStrings): Boolean;

+Search LDAP base for LDAP objects by Filter.

+ + + + + +

function Extended(const Name, Value: AnsiString): Boolean;

+Call any LDAPv3 extended command.

+ + + + + +

function StartTLS: Boolean;

+Try to start SSL/TLS connection to LDAP server.

Properties

+ + + + + +

property Version: integer read FVersion Write FVersion;

+Specify version of used LDAP protocol. Default value is 3.

+ + + + + +

property ResultCode: Integer read FResultCode;

+Result code of last LDAP operation.

+ + + + + +

property ResultString: AnsiString read FResultString;

+Human readable description of result code of last LDAP operation.

+ + + + + +

property FullResult: AnsiString read FFullResult;

+Binary string with full last response of LDAP server. This string is encoded by ASN.1 BER encoding! You need this only for debugging.

+ + + + + +

property AutoTLS: Boolean read FAutoTLS Write FAutoTLS;

+If True, then try to start TSL mode in Login procedure.

+ + + + + +

property FullSSL: Boolean read FFullSSL Write FFullSSL;

+If True, then use connection to LDAP server through SSL/TLS tunnel.

+ + + + + +

property Seq: integer read FSeq;

+Sequence number of last LDAp command. It is incremented by any LDAP command.

+ + + + + +

property SearchScope: TLDAPSearchScope read FSearchScope Write FSearchScope;

+Specify what search scope is used in search command.

+ + + + + +

property SearchAliases: TLDAPSearchAliases read FSearchAliases Write FSearchAliases;

+Specify how to handle aliases in search command.

+ + + + + +

property SearchSizeLimit: integer read FSearchSizeLimit Write FSearchSizeLimit;

+Specify result size limit in search command. Value 0 means without limit.

+ + + + + +

property SearchTimeLimit: integer read FSearchTimeLimit Write FSearchTimeLimit;

+Specify search time limit in search command (seconds). Value 0 means without limit.

+ + + + + +

property SearchResult: TLDAPResultList read FSearchResult;

+Here is result of search command.

+ + + + + +

property Referals: TStringList read FReferals;

+On each LDAP operation can LDAP server return some referals URLs. Here is their list.

+ + + + + +

property ExtName: AnsiString read FExtName;

+When you call Extended operation, then here is result Name returned by server.

+ + + + + +

property ExtValue: AnsiString read FExtValue;

+When you call Extended operation, then here is result Value returned by server.

+ + + + + +

property Sock: TTCPBlockSocket read FSock;

+TCP socket used by all LDAP operations.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/ldapsend.html Index: lib/synapse/docs/help/ldapsend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/ldapsend.html @@ -0,0 +1,299 @@ + + + + + +ldapsend + + + +

Unit ldapsend

+ + +

Variables

Description

+LDAP client

+ + +

Used RFC: RFC-2251, RFC-2254, RFC-2829, RFC-2830

uses

Overview

Classes, Interfaces, Objects and Records

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Name	Description
Class `TLDAPAttribute`	LDAP attribute with list of their values
Class `TLDAPAttributeList`	List of TLDAPAttribute
Class `TLDAPResult`	LDAP result object
Class `TLDAPResultList`	List of LDAP result objects
Class `TLDAPSend`	Implementation of LDAP client

Functions and Procedures

+ + + + +

function LDAPResultDump(const Value: TLDAPResultList): AnsiString;

Types

+ + + + + + + + + + +

TLDAPModifyOp = (...);

TLDAPSearchScope = (...);

TLDAPSearchAliases = (...);

Constants

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

cLDAPProtocol = '389';

LDAP_ASN1_BIND_REQUEST = $60;

LDAP_ASN1_BIND_RESPONSE = $61;

LDAP_ASN1_UNBIND_REQUEST = $42;

LDAP_ASN1_SEARCH_REQUEST = $63;

LDAP_ASN1_SEARCH_ENTRY = $64;

LDAP_ASN1_SEARCH_DONE = $65;

LDAP_ASN1_SEARCH_REFERENCE = $73;

LDAP_ASN1_MODIFY_REQUEST = $66;

LDAP_ASN1_MODIFY_RESPONSE = $67;

LDAP_ASN1_ADD_REQUEST = $68;

LDAP_ASN1_ADD_RESPONSE = $69;

LDAP_ASN1_DEL_REQUEST = $4A;

LDAP_ASN1_DEL_RESPONSE = $6B;

LDAP_ASN1_MODIFYDN_REQUEST = $6C;

LDAP_ASN1_MODIFYDN_RESPONSE = $6D;

LDAP_ASN1_COMPARE_REQUEST = $6E;

LDAP_ASN1_COMPARE_RESPONSE = $6F;

LDAP_ASN1_ABANDON_REQUEST = $70;

LDAP_ASN1_EXT_REQUEST = $77;

LDAP_ASN1_EXT_RESPONSE = $78;

Description

Functions and Procedures

+ + + + +

function LDAPResultDump(const Value: TLDAPResultList): AnsiString;

+Dump result of LDAP SEARCH into human readable form. Good for debugging.

Types

+ + + + +

TLDAPModifyOp = (...);

+Define possible operations for LDAP MODIFY operations.

+MO_Add:
+MO_Delete:
+MO_Replace:

+ + + + +

TLDAPSearchScope = (...);

+Specify possible values for search scope.

+SS_BaseObject:
+SS_SingleLevel:
+SS_WholeSubtree:

+ + + + +

TLDAPSearchAliases = (...);

+Specify possible values about alias dereferencing.

+SA_NeverDeref:
+SA_InSearching:
+SA_FindingBaseObj:
+SA_Always:

Constants

+ + + + +

cLDAPProtocol = '389';

+ + + + +

LDAP_ASN1_BIND_REQUEST = $60;

+ + + + +

LDAP_ASN1_BIND_RESPONSE = $61;

+ + + + +

LDAP_ASN1_UNBIND_REQUEST = $42;

+ + + + +

LDAP_ASN1_SEARCH_REQUEST = $63;

+ + + + +

LDAP_ASN1_SEARCH_ENTRY = $64;

+ + + + +

LDAP_ASN1_SEARCH_DONE = $65;

+ + + + +

LDAP_ASN1_SEARCH_REFERENCE = $73;

+ + + + +

LDAP_ASN1_MODIFY_REQUEST = $66;

+ + + + +

LDAP_ASN1_MODIFY_RESPONSE = $67;

+ + + + +

LDAP_ASN1_ADD_REQUEST = $68;

+ + + + +

LDAP_ASN1_ADD_RESPONSE = $69;

+ + + + +

LDAP_ASN1_DEL_REQUEST = $4A;

+ + + + +

LDAP_ASN1_DEL_RESPONSE = $6B;

+ + + + +

LDAP_ASN1_MODIFYDN_REQUEST = $6C;

+ + + + +

LDAP_ASN1_MODIFYDN_RESPONSE = $6D;

+ + + + +

LDAP_ASN1_COMPARE_REQUEST = $6E;

+ + + + +

LDAP_ASN1_COMPARE_RESPONSE = $6F;

+ + + + +

LDAP_ASN1_ABANDON_REQUEST = $70;

+ + + + +

LDAP_ASN1_EXT_REQUEST = $77;

+ + + + +

LDAP_ASN1_EXT_RESPONSE = $78;

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/legend.html Index: lib/synapse/docs/help/legend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/legend.html @@ -0,0 +1,39 @@ + + + + + +Legend + + + +

Legend

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Marker	Visibility
	Private
	Protected
	Public
	Published
	Automated

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:53 + + ADDED lib/synapse/docs/help/mimeinln.html Index: lib/synapse/docs/help/mimeinln.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/mimeinln.html @@ -0,0 +1,100 @@ + + + + + +mimeinln + + + +

Unit mimeinln

+ + +

Classes, Interfaces, Objects and Records

Types

Constants

Variables

Description

+Utilities for inline MIME

+ Support for Inline MIME encoding and decoding. + +

Used RFC: RFC-2047, RFC-2231

uses

SysUtils
Classes
synachar
synacode
synautil

Overview

Functions and Procedures

+ + + + + + + + + + + + + + + + + + + + + + +

function InlineDecode(const Value: string; CP: TMimeChar): string;

function InlineEncode(const Value: string; CP, MimeP: TMimeChar): string;

function NeedInline(const Value: AnsiString): boolean;

function InlineCodeEx(const Value: string; FromCP: TMimeChar): string;

function InlineCode(const Value: string): string;

function InlineEmailEx(const Value: string; FromCP: TMimeChar): string;

function InlineEmail(const Value: string): string;

Description

Functions and Procedures

+ + + + +

function InlineDecode(const Value: string; CP: TMimeChar): string;

+Decodes mime inline encoding (i.e. in headers) uses target characterset "CP".

+ + + + +

function InlineEncode(const Value: string; CP, MimeP: TMimeChar): string;

+Encodes string to MIME inline encoding. The source characterset is "CP", and the target charset is "MimeP".

+ + + + +

function NeedInline(const Value: AnsiString): boolean;

+Returns True, if "Value" contains characters needed for inline coding.

+ + + + +

function InlineCodeEx(const Value: string; FromCP: TMimeChar): string;

+Inline mime encoding similar to InlineEncode, but you can specify source charset, and the target characterset is automatically assigned.

+ + + + +

function InlineCode(const Value: string): string;

+Inline MIME encoding similar to InlineEncode, but the source charset is automatically set to the system default charset, and the target charset is automatically assigned from set of allowed encoding for MIME.

+ + + + +

function InlineEmailEx(const Value: string; FromCP: TMimeChar): string;

+Converts e-mail address to canonical mime form. You can specify source charset.

+ + + + +

function InlineEmail(const Value: string): string;

+Converts e-mail address to canonical mime form. Source charser it system default charset.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/mimemess.TMessHeader.html Index: lib/synapse/docs/help/mimemess.TMessHeader.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/mimemess.TMessHeader.html @@ -0,0 +1,263 @@ + + + + + +mimemess: Class TMessHeader + + + +

Class TMessHeader

+ + +

Fields

Unit

+mimemess

Declaration

+type TMessHeader = class(TObject)

Description

+Object for basic e-mail header fields.

Hierarchy

TObject
TMessHeader

Overview

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`constructor Create; virtual;`
	`destructor Destroy; override;`
	`procedure Clear; virtual;`
	`procedure EncodeHeaders(const Value: TStrings); virtual;`
	`procedure DecodeHeaders(const Value: TStrings);`
	`function FindHeader(Value: string): string;`
	`procedure FindHeaderList(Value: string; const HeaderList: TStrings);`

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`property From: string read FFrom Write FFrom;`
	`property ToList: TStringList read FToList;`
	`property CCList: TStringList read FCCList;`
	`property Subject: string read FSubject Write FSubject;`
	`property Organization: string read FOrganization Write FOrganization;`
	`property CustomHeaders: TStringList read FCustomHeaders;`
	`property Date: TDateTime read FDate Write FDate;`
	`property XMailer: string read FXMailer Write FXMailer;`
	`property ReplyTo: string read FReplyTo Write FReplyTo;`
	`property MessageID: string read FMessageID Write FMessageID;`
	`property Priority: TMessPriority read FPriority Write FPriority;`
	`property CharsetCode: TMimeChar read FCharsetCode Write FCharsetCode;`

Description

Methods

+ + + + + +

constructor Create; virtual;

+ + + + + +

destructor Destroy; override;

+ + + + + +

procedure Clear; virtual;

+Clears all data fields.

+ + + + + +

procedure EncodeHeaders(const Value: TStrings); virtual;

+ + + + + +

procedure DecodeHeaders(const Value: TStrings);

+Parse header from Value to this object.

+ + + + + +

function FindHeader(Value: string): string;

+Try find specific header in CustomHeader. Search is case insensitive. This is good for reading any non-parsed header.

+ + + + + +

procedure FindHeaderList(Value: string; const HeaderList: TStrings);

+Try find specific headers in CustomHeader. This metod is for repeatly used headers like 'received' header, etc. Search is case insensitive. This is good for reading ano non-parsed header.

Properties

+ + + + + +

property From: string read FFrom Write FFrom;

+Sender of message.

+ + + + + +

property ToList: TStringList read FToList;

+Stringlist with receivers of message. (one per line)

+ + + + + +

property CCList: TStringList read FCCList;

+Stringlist with Carbon Copy receivers of message. (one per line)

+ + + + + +

property Subject: string read FSubject Write FSubject;

+Subject of message.

+ + + + + +

property Organization: string read FOrganization Write FOrganization;

+Organization string.

+ + + + + +

property CustomHeaders: TStringList read FCustomHeaders;

+After decoding contains all headers lines witch not have parsed to any other structures in this object. It mean: this conatins all other headers except: + +

X-MAILER, FROM, SUBJECT, ORGANIZATION, TO, CC, DATE, MIME-VERSION, CONTENT-TYPE, CONTENT-DESCRIPTION, CONTENT-DISPOSITION, CONTENT-ID, CONTENT-TRANSFER-ENCODING, REPLY-TO, MESSAGE-ID, X-MSMAIL-PRIORITY, X-PRIORITY, PRIORITY + +

When you encode headers, all this lines is added as headers. Be carefull for duplicites!

+ + + + + +

property Date: TDateTime read FDate Write FDate;

+Date and time of message.

+ + + + + +

property XMailer: string read FXMailer Write FXMailer;

+Mailer identification.

+ + + + + +

property ReplyTo: string read FReplyTo Write FReplyTo;

+Address for replies

+ + + + + +

property MessageID: string read FMessageID Write FMessageID;

+message indetifier

+ + + + + +

property Priority: TMessPriority read FPriority Write FPriority;

+message priority

+ + + + + +

property CharsetCode: TMimeChar read FCharsetCode Write FCharsetCode;

+Specify base charset. By default is used system charset.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/mimemess.TMimeMess.html Index: lib/synapse/docs/help/mimemess.TMimeMess.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/mimemess.TMimeMess.html @@ -0,0 +1,331 @@ + + + + + +mimemess: Class TMimeMess + + + +

Class TMimeMess

+ + +

Fields

Unit

+mimemess

Declaration

+type TMimeMess = class(TObject)

Description

+Object for handling of e-mail message.

Hierarchy

TObject
TMimeMess

Overview

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`constructor Create;`
	`constructor CreateAltHeaders(HeadClass: TMessHeaderClass);`
	`destructor Destroy; override;`
	`procedure Clear; virtual;`
	`function AddPart(const PartParent: TMimePart): TMimePart;`
	`function AddPartMultipart(const MultipartType: String; const PartParent: TMimePart): TMimePart;`
	`function AddPartText(const Value: TStrings; const PartParent: TMimePart): TMimepart;`
	`function AddPartTextEx(const Value: TStrings; const PartParent: TMimePart; PartCharset: TMimeChar; Raw: Boolean; PartEncoding: TMimeEncoding): TMimepart;`
	`function AddPartHTML(const Value: TStrings; const PartParent: TMimePart): TMimepart;`
	`function AddPartTextFromFile(const FileName: String; const PartParent: TMimePart): TMimepart;`
	`function AddPartHTMLFromFile(const FileName: String; const PartParent: TMimePart): TMimepart;`
	`function AddPartBinary(const Stream: TStream; const FileName: string; const PartParent: TMimePart): TMimepart;`
	`function AddPartBinaryFromFile(const FileName: string; const PartParent: TMimePart): TMimepart;`
	`function AddPartHTMLBinary(const Stream: TStream; const FileName, Cid: string; const PartParent: TMimePart): TMimepart;`
	`function AddPartHTMLBinaryFromFile(const FileName, Cid: string; const PartParent: TMimePart): TMimepart;`
	`function AddPartMess(const Value: TStrings; const PartParent: TMimePart): TMimepart;`
	`function AddPartMessFromFile(const FileName: string; const PartParent: TMimePart): TMimepart;`
	`procedure EncodeMessage;`
	`procedure DecodeMessage;`
	`procedure DecodeMessageBinary(AHeader:TStrings; AData:TMemoryStream);`

Properties

+ + + + + + + + + + + + + +

	`property MessagePart: TMimePart read FMessagePart;`
	`property Lines: TStringList read FLines;`
	`property Header: TMessHeader read FHeader;`

Description

Methods

+ + + + + +

constructor Create;

+ + + + + +

constructor CreateAltHeaders(HeadClass: TMessHeaderClass);

+create this object and assign your own descendant of TMessHeader object to Header property. So, you can create your own message headers parser and use it by this object.

+ + + + + +

destructor Destroy; override;

+ + + + + +

procedure Clear; virtual;

+Reset component to default state.

+ + + + + +

function AddPart(const PartParent: TMimePart): TMimePart;

+Add MIME part as subpart of PartParent. If you need set root MIME part, then set as PartParent Nil value. If you need set more then one subpart, you must have PartParent of multipart type!

+ + + + + +

function AddPartMultipart(const MultipartType: String; const PartParent: TMimePart): TMimePart;

+Add MIME part as subpart of PartParent. If you need set root MIME part, then set as PartParent Nil value. If you need set more then 1 subpart, you must have PartParent of multipart type! + +

This part is marked as multipart with secondary MIME type specified by MultipartType parameter. (typical value is 'mixed') + +

This part can be used as PartParent for another parts (include next multipart). If you need only one part, then you not need Multipart part.

+ + + + + +

function AddPartText(const Value: TStrings; const PartParent: TMimePart): TMimepart;

+Add MIME part as subpart of PartParent. If you need set root MIME part, then set as PartParent Nil value. If you need set more then 1 subpart, you must have PartParent of multipart type! + +

After creation of part set type to text part and set all necessary properties. Content of part is readed from value stringlist.

+ + + + + +

function AddPartTextEx(const Value: TStrings; const PartParent: TMimePart; PartCharset: TMimeChar; Raw: Boolean; PartEncoding: TMimeEncoding): TMimepart;

+Add MIME part as subpart of PartParent. If you need set root MIME part, then set as PartParent Nil value. If you need set more then 1 subpart, you must have PartParent of multipart type! + +

+ + + + + +

function AddPartHTML(const Value: TStrings; const PartParent: TMimePart): TMimepart;

+Add MIME part as subpart of PartParent. If you need set root MIME part, then set as PartParent Nil value. If you need set more then 1 subpart, you must have PartParent of multipart type! + +

After creation of part set type to text part to HTML type and set all necessary properties. Content of HTML part is readed from Value stringlist.

+ + + + + +

function AddPartTextFromFile(const FileName: String; const PartParent: TMimePart): TMimepart;

+Same as AddPartText, but content is readed from file

+ + + + + +

function AddPartHTMLFromFile(const FileName: String; const PartParent: TMimePart): TMimepart;

+Same as AddPartHTML, but content is readed from file

+ + + + + +

function AddPartBinary(const Stream: TStream; const FileName: string; const PartParent: TMimePart): TMimepart;

+Add MIME part as subpart of PartParent. If you need set root MIME part, then set as PartParent Nil value. If you need set more then 1 subpart, you must have PartParent of multipart type! + +

+ + + + + +

function AddPartBinaryFromFile(const FileName: string; const PartParent: TMimePart): TMimepart;

+Same as AddPartBinary, but content is readed from file

+ + + + + +

function AddPartHTMLBinary(const Stream: TStream; const FileName, Cid: string; const PartParent: TMimePart): TMimepart;

+Add MIME part as subpart of PartParent. If you need set root MIME part, then set as PartParent Nil value. If you need set more then 1 subpart, you must have PartParent of multipart type! + +

This binary part is encoded as inline data with given Conten ID (cid). Content ID can be used as reference ID in HTML source in HTML part.

+ + + + + +

function AddPartHTMLBinaryFromFile(const FileName, Cid: string; const PartParent: TMimePart): TMimepart;

+Same as AddPartHTMLBinary, but content is readed from file

+ + + + + +

function AddPartMess(const Value: TStrings; const PartParent: TMimePart): TMimepart;

+Add MIME part as subpart of PartParent. If you need set root MIME part, then set as PartParent Nil value. If you need set more then 1 subpart, you must have PartParent of multipart type! + +

After creation of part set type to message and set all necessary properties. MIME primary and secondary types are setted to 'message/rfc822'. Content of raw RFC-822 message is readed from Stream.

+ + + + + +

function AddPartMessFromFile(const FileName: string; const PartParent: TMimePart): TMimepart;

+Same as AddPartMess, but content is readed from file

+ + + + + +

procedure EncodeMessage;

+Compose message from MessagePart to Lines. Headers from Header object is added also.

+ + + + + +

procedure DecodeMessage;

+Decode message from Lines to MessagePart. Massage headers are parsed into Header object.

+ + + + + +

procedure DecodeMessageBinary(AHeader:TStrings; AData:TMemoryStream);

+HTTP message is received by THTTPSend component in two parts: headers are stored in THTTPSend.Headers and a body in memory stream THTTPSend.Document. + +

On the top of it, HTTP connections are always 8-bit, hence data are transferred in native format i.e. no transfer encoding is applied. + +

This method operates the similiar way and produces the same result as DecodeMessage.

Properties

+ + + + + +

property MessagePart: TMimePart read FMessagePart;

+TMimePart object with decoded MIME message. This object can handle any number of nested TMimePart objects itself. It is used for handle any tree of MIME subparts.

+ + + + + +

property Lines: TStringList read FLines;

+Raw MIME encoded message.

+ + + + + +

property Header: TMessHeader read FHeader;

+Object for e-mail header fields. This object is created automaticly. Do not free this object!

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/mimemess.html Index: lib/synapse/docs/help/mimemess.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/mimemess.html @@ -0,0 +1,71 @@ + + + + + +mimemess + + + +

Unit mimemess

+ + +

Functions and Procedures

Constants

Variables

Description

+MIME message handling

+ Classes for easy handling with e-mail message.

uses

Overview

Classes, Interfaces, Objects and Records

+ + + + + + + + + + + + + +

Name	Description
Class `TMessHeader`	Object for basic e-mail header fields.
Class `TMimeMess`	Object for handling of e-mail message.

Types

+ + + + + + + +

TMessPriority = (...);

TMessHeaderClass = class of TMessHeader;

Description

Types

+ + + + +

TMessPriority = (...);

+Possible values for message priority

+MP_unknown:
+MP_low:
+MP_normal:
+MP_high:

+ + + + +

TMessHeaderClass = class of TMessHeader;

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/mimepart.TMimePart.html Index: lib/synapse/docs/help/mimepart.TMimePart.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/mimepart.TMimePart.html @@ -0,0 +1,615 @@ + + + + + +mimepart: Class TMimePart + + + +

Class TMimePart

+ + +

Fields

Unit

+mimepart

Declaration

+type TMimePart = class(TObject)

Description

+Object for working with parts of MIME e-mail.

+ Each TMimePart object can handle any number of nested subparts as new TMimepart objects. It can handle any tree hierarchy structure of nested MIME subparts itself. + +

Basic tasks are: + +

Decoding of MIME message: - store message into Lines property - call DecomposeParts. Now you have decomposed MIME parts in all nested levels! - now you can explore all properties and subparts. (You can use WalkPart method) - if you need decode part, call DecodePart. + +

Encoding of MIME message: + +

Hierarchy

TObject
TMimePart

Overview

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`constructor Create;`
	`destructor Destroy; override;`
	`procedure Assign(Value: TMimePart);`
	`procedure AssignSubParts(Value: TMimePart);`
	`procedure Clear;`
	`procedure DecodePart;`
	`procedure DecodePartHeader;`
	`procedure EncodePart;`
	`procedure EncodePartHeader;`
	`procedure MimeTypeFromExt(Value: string);`
	`function GetSubPartCount: integer;`
	`function GetSubPart(index: integer): TMimePart;`
	`procedure DeleteSubPart(index: integer);`
	`procedure ClearSubParts;`
	`function AddSubPart: TMimePart;`
	`procedure DecomposeParts;`
	`procedure DecomposePartsBinary(AHeader:TStrings; AStx,AEtx:PANSIChar);`
	`procedure ComposeParts;`
	`procedure WalkPart;`
	`function CanSubPart: boolean;`

Properties

	`property Primary: string read FPrimary write SetPrimary;`
	`property Encoding: string read FEncoding write SetEncoding;`
	`property Charset: string read FCharset write SetCharset;`
	`property DefaultCharset: string read FDefaultCharset write FDefaultCharset;`
	`property PrimaryCode: TMimePrimary read FPrimaryCode Write FPrimaryCode;`
	`property EncodingCode: TMimeEncoding read FEncodingCode Write FEncodingCode;`
	`property CharsetCode: TMimeChar read FCharsetCode Write FCharsetCode;`
	`property TargetCharset: TMimeChar read FTargetCharset Write FTargetCharset;`
	`property ConvertCharset: Boolean read FConvertCharset Write FConvertCharset;`
	`property ForcedHTMLConvert: Boolean read FForcedHTMLConvert Write FForcedHTMLConvert;`
	`property Secondary: string read FSecondary Write FSecondary;`
	`property Description: string read FDescription Write FDescription;`
	`property Disposition: string read FDisposition Write FDisposition;`
	`property ContentID: string read FContentID Write FContentID;`
	`property Boundary: string read FBoundary Write FBoundary;`
	`property FileName: string read FFileName Write FFileName;`
	`property Lines: TStringList read FLines;`
	`property PartBody: TStringList read FPartBody;`
	`property Headers: TStringList read FHeaders;`
	`property PrePart: TStringList read FPrePart;`
	`property PostPart: TStringList read FPostPart;`
	`property DecodedLines: TMemoryStream read FDecodedLines;`
	`property SubLevel: integer read FSubLevel write FSubLevel;`
	`property MaxSubLevel: integer read FMaxSubLevel write FMaxSubLevel;`
	`property AttachInside: boolean read FAttachInside;`
	`property OnWalkPart: THookWalkPart read FOnWalkPart write FOnWalkPart;`
	`property MaxLineLength: integer read FMaxLineLength Write FMaxLineLength;`

Description

Methods

+ + + + + +

constructor Create;

+ + + + + +

destructor Destroy; override;

+ + + + + +

procedure Assign(Value: TMimePart);

+Assign content of another object to this object. (Only this part, not subparts!)

+ + + + + +

procedure AssignSubParts(Value: TMimePart);

+Assign content of another object to this object. (With all subparts!)

+ + + + + +

procedure Clear;

+Clear all data values to default values. It also call ClearSubParts.

+ + + + + +

procedure DecodePart;

+Decode Mime part from Lines to DecodedLines.

+ + + + + +

procedure DecodePartHeader;

+Parse header lines from Headers property into another properties.

+ + + + + +

procedure EncodePart;

+Encode mime part from DecodedLines to Lines and build mime headers.

+ + + + + +

procedure EncodePartHeader;

+Build header lines in Headers property from another properties.

+ + + + + +

procedure MimeTypeFromExt(Value: string);

+generate primary and secondary mime type from filename extension in value. If type not recognised, it return 'Application/octet-string' type.

+ + + + + +

function GetSubPartCount: integer;

+Return number of decomposed subparts. (On this level! Each of this subparts can hold any number of their own nested subparts!)

+ + + + + +

function GetSubPart(index: integer): TMimePart;

+Get nested subpart object as new TMimePart. For getting maximum possible index you can use GetSubPartCount method.

+ + + + + +

procedure DeleteSubPart(index: integer);

+delete subpart on given index.

+ + + + + +

procedure ClearSubParts;

+Clear and destroy all subpart TMimePart objects.

+ + + + + +

function AddSubPart: TMimePart;

+Add and create new subpart.

+ + + + + +

procedure DecomposeParts;

+E-mail message in Lines property is parsed into this object. E-mail headers are stored in Headers property and is parsed into another properties automaticly. Not need call DecodePartHeader! Content of message (part) is stored into PartBody property. This part is in undecoded form! If you need decode it, then you must call DecodePart method by your hands. Lot of another properties is filled also. + +

Decoding of parts you must call separately due performance reasons. (Not needed to decode all parts in all reasons.) + +

For each MIME subpart is created new TMimepart object (accessible via method GetSubPart).

+ + + + + +

procedure DecomposePartsBinary(AHeader:TStrings; AStx,AEtx:PANSIChar);

+HTTP message is received by THTTPSend component in two parts: headers are stored in THTTPSend.Headers and a body in memory stream THTTPSend.Document. + +

On the top of it, HTTP connections are always 8-bit, hence data are transferred in native format i.e. no transfer encoding is applied. + +

This method operates the similiar way and produces the same result as DecomposeParts.

+ + + + + +

procedure ComposeParts;

+This part and all subparts is composed into one MIME message stored in Lines property.

+ + + + + +

procedure WalkPart;

+By calling this method is called OnWalkPart event for each part and their subparts. It is very good for calling some code for each part in MIME message

+ + + + + +

function CanSubPart: boolean;

+Return True when is possible create next subpart. (MaxSubLevel is still not reached)

Properties

+ + + + + +

property Primary: string read FPrimary write SetPrimary;

+Primary Mime type of part. (i.e. 'application') Writing to this property automaticly generate value of PrimaryCode.

+ + + + + +

property Encoding: string read FEncoding write SetEncoding;

+String representation of used Mime encoding in part. (i.e. 'base64') Writing to this property automaticly generate value of EncodingCode.

+ + + + + +

property Charset: string read FCharset write SetCharset;

+String representation of used Mime charset in part. (i.e. 'iso-8859-1') Writing to this property automaticly generate value of CharsetCode. Charset is used only for text parts.

+ + + + + +

property DefaultCharset: string read FDefaultCharset write FDefaultCharset;

+Define default charset for decoding text MIME parts without charset specification. Default value is 'ISO-8859-1' by RCF documents. But Microsoft Outlook use windows codings as default. This property allows properly decode textual parts from some broken versions of Microsoft Outlook. (this is bad software!)

+ + + + + +

property PrimaryCode: TMimePrimary read FPrimaryCode Write FPrimaryCode;

+Decoded primary type. Possible values are: MP_TEXT, MP_MULTIPART, MP_MESSAGE and MP_BINARY. If type not recognised, result is MP_BINARY.

+ + + + + +

property EncodingCode: TMimeEncoding read FEncodingCode Write FEncodingCode;

+Decoded encoding type. Possible values are: ME_7BIT, ME_8BIT, ME_QUOTED_PRINTABLE and ME_BASE64. If type not recognised, result is ME_7BIT.

+ + + + + +

property CharsetCode: TMimeChar read FCharsetCode Write FCharsetCode;

+Decoded charset type. Possible values are defined in synachar unit.

+ + + + + +

property TargetCharset: TMimeChar read FTargetCharset Write FTargetCharset;

+System charset type. Default value is charset used by default in your operating system.

+ + + + + +

property ConvertCharset: Boolean read FConvertCharset Write FConvertCharset;

+If True, then do internal charset translation of part content between CharsetCode and TargetCharset

+ + + + + +

property ForcedHTMLConvert: Boolean read FForcedHTMLConvert Write FForcedHTMLConvert;

+If True, then allways do internal charset translation of HTML parts by MIME even it have their own charset in META tag. Default is False.

+ + + + + +

property Secondary: string read FSecondary Write FSecondary;

+Secondary Mime type of part. (i.e. 'mixed')

+ + + + + +

property Description: string read FDescription Write FDescription;

+Description of Mime part.

+ + + + + +

property Disposition: string read FDisposition Write FDisposition;

+Value of content disposition field. (i.e. 'inline' or 'attachment')

+ + + + + +

property ContentID: string read FContentID Write FContentID;

+Content ID.

+ + + + + +

property Boundary: string read FBoundary Write FBoundary;

+Boundary delimiter of multipart Mime part. Used only in multipart part.

+ + + + + +

property FileName: string read FFileName Write FFileName;

+Filename of file in binary part.

+ + + + + +

property Lines: TStringList read FLines;

+String list with lines contains mime part (It can be a full message).

+ + + + + +

property PartBody: TStringList read FPartBody;

+Encoded form of MIME part data.

+ + + + + +

property Headers: TStringList read FHeaders;

+All header lines of MIME part.

+ + + + + +

property PrePart: TStringList read FPrePart;

+On multipart this contains part of message between first line of message and first boundary.

+ + + + + +

property PostPart: TStringList read FPostPart;

+On multipart this contains part of message between last boundary and end of message.

+ + + + + +

property DecodedLines: TMemoryStream read FDecodedLines;

+Stream with decoded form of budy part.

+ + + + + +

property SubLevel: integer read FSubLevel write FSubLevel;

+Show nested level in subpart tree. Value 0 means root part. 1 means subpart from this root. etc.

+ + + + + +

property MaxSubLevel: integer read FMaxSubLevel write FMaxSubLevel;

+Specify maximum sublevel value for decomposing.

+ + + + + +

property AttachInside: boolean read FAttachInside;

+When is True, then this part maybe(!) have included some uuencoded binary data.

+ + + + + +

property OnWalkPart: THookWalkPart read FOnWalkPart write FOnWalkPart;

+Here you can assign hook procedure for walking through all part and their subparts.

+ + + + + +

property MaxLineLength: integer read FMaxLineLength Write FMaxLineLength;

+Here you can specify maximum line length for encoding of MIME part. If line is longer, then is splitted by standard of MIME. Correct MIME mailers can de-split this line into original length.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/mimepart.html Index: lib/synapse/docs/help/mimepart.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/mimepart.html @@ -0,0 +1,187 @@ + + + + + +mimepart + + + +

Unit mimepart

+ + +

Variables

Description

+MIME part handling

+ Handling with MIME parts. + +

Used RFC: RFC-2045

uses

Overview

Classes, Interfaces, Objects and Records

+ + + + + + + + + +

Name	Description
Class `TMimePart`	Object for working with parts of MIME e-mail.

Functions and Procedures

+ + + + +

function GenerateBoundary: string;

Types

+ + + + + + + + + + +

THookWalkPart = procedure(const Sender: TMimePart) of object;

TMimePrimary = (...);

TMimeEncoding = (...);

Constants

+ + + + + + + +

MaxMimeType = 25;

MimeType: array[0..MaxMimeType, 0..2] of string =
+  (
+    ('AU', 'audio', 'basic'),
+    ('AVI', 'video', 'x-msvideo'),
+    ('BMP', 'image', 'BMP'),
+    ('DOC', 'application', 'MSWord'),
+    ('EPS', 'application', 'Postscript'),
+    ('GIF', 'image', 'GIF'),
+    ('JPEG', 'image', 'JPEG'),
+    ('JPG', 'image', 'JPEG'),
+    ('MID', 'audio', 'midi'),
+    ('MOV', 'video', 'quicktime'),
+    ('MPEG', 'video', 'MPEG'),
+    ('MPG', 'video', 'MPEG'),
+    ('MP2', 'audio', 'mpeg'),
+    ('MP3', 'audio', 'mpeg'),
+    ('PDF', 'application', 'PDF'),
+    ('PNG', 'image', 'PNG'),
+    ('PS', 'application', 'Postscript'),
+    ('QT', 'video', 'quicktime'),
+    ('RA', 'audio', 'x-realaudio'),
+    ('RTF', 'application', 'RTF'),
+    ('SND', 'audio', 'basic'),
+    ('TIF', 'image', 'TIFF'),
+    ('TIFF', 'image', 'TIFF'),
+    ('WAV', 'audio', 'x-wav'),
+    ('WPD', 'application', 'Wordperfect5.1'),
+    ('ZIP', 'application', 'ZIP')
+    );

Description

Functions and Procedures

+ + + + +

function GenerateBoundary: string;

+Generates a unique boundary string.

Types

+ + + + +

THookWalkPart = procedure(const Sender: TMimePart) of object;

+Procedural type for TMimePart.WalkPart hook

+. This hook is used for easy walking through MIME subparts.

+ + + + +

TMimePrimary = (...);

+The four types of MIME parts. (textual, multipart, message or any other binary data.)

+MP_TEXT:
+MP_MULTIPART:
+MP_MESSAGE:
+MP_BINARY:

+ + + + +

TMimeEncoding = (...);

+The various types of possible part encodings.

+ME_7BIT:
+ME_8BIT:
+ME_QUOTED_PRINTABLE:
+ME_BASE64:
+ME_UU:
+ME_XX:

Constants

+ + + + +

MaxMimeType = 25;

+ + + + +

MimeType: array[0..MaxMimeType, 0..2] of string =
+  (
+    ('AU', 'audio', 'basic'),
+    ('AVI', 'video', 'x-msvideo'),
+    ('BMP', 'image', 'BMP'),
+    ('DOC', 'application', 'MSWord'),
+    ('EPS', 'application', 'Postscript'),
+    ('GIF', 'image', 'GIF'),
+    ('JPEG', 'image', 'JPEG'),
+    ('JPG', 'image', 'JPEG'),
+    ('MID', 'audio', 'midi'),
+    ('MOV', 'video', 'quicktime'),
+    ('MPEG', 'video', 'MPEG'),
+    ('MPG', 'video', 'MPEG'),
+    ('MP2', 'audio', 'mpeg'),
+    ('MP3', 'audio', 'mpeg'),
+    ('PDF', 'application', 'PDF'),
+    ('PNG', 'image', 'PNG'),
+    ('PS', 'application', 'Postscript'),
+    ('QT', 'video', 'quicktime'),
+    ('RA', 'audio', 'x-realaudio'),
+    ('RTF', 'application', 'RTF'),
+    ('SND', 'audio', 'basic'),
+    ('TIF', 'image', 'TIFF'),
+    ('TIFF', 'image', 'TIFF'),
+    ('WAV', 'audio', 'x-wav'),
+    ('WPD', 'application', 'Wordperfect5.1'),
+    ('ZIP', 'application', 'ZIP')
+    );

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/navigation.html Index: lib/synapse/docs/help/navigation.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/navigation.html @@ -0,0 +1,24 @@ + + + + +Navigation + + +

+ + + + + + + + + + + + ADDED lib/synapse/docs/help/nntpsend.TNNTPSend.html Index: lib/synapse/docs/help/nntpsend.TNNTPSend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/nntpsend.TNNTPSend.html @@ -0,0 +1,398 @@ + + + + + +nntpsend: Class TNNTPSend + + + +

Class TNNTPSend

+ + +

Fields

Unit

+nntpsend

Declaration

+type TNNTPSend = class(TSynaClient)

Description

+abstract(Implementation of Network News Transfer Protocol. + +

Note: Are you missing properties for setting Username and Password? Look to parent TSynaClient object! + +

Are you missing properties for specify server address and port? Look to parent TSynaClient too!

Hierarchy

TObject
TSynaClient
TNNTPSend

Overview

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`constructor Create;`
	`destructor Destroy; override;`
	`function Login: Boolean;`
	`function Logout: Boolean;`
	`function DoCommand(const Command: string): boolean;`
	`function DoCommandRead(const Command: string): boolean;`
	`function DoCommandWrite(const Command: string): boolean;`
	`function GetArticle(const Value: string): Boolean;`
	`function GetBody(const Value: string): Boolean;`
	`function GetHead(const Value: string): Boolean;`
	`function GetStat(const Value: string): Boolean;`
	`function SelectGroup(const Value: string): Boolean;`
	`function IHave(const MessID: string): Boolean;`
	`function GotoLast: Boolean;`
	`function GotoNext: Boolean;`
	`function ListGroups: Boolean;`
	`function ListNewGroups(Since: TDateTime): Boolean;`
	`function NewArticles(const Group: string; Since: TDateTime): Boolean;`
	`function PostArticle: Boolean;`
	`function SwitchToSlave: Boolean;`
	`function Xover(xoStart, xoEnd: string): boolean;`
	`function StartTLS: Boolean;`
	`function FindCap(const Value: string): string;`
	`function ListExtensions: Boolean;`

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + +

	`property ResultCode: Integer read FResultCode;`
	`property ResultString: string read FResultString;`
	`property Data: TStringList read FData;`
	`property AutoTLS: Boolean read FAutoTLS Write FAutoTLS;`
	`property FullSSL: Boolean read FFullSSL Write FFullSSL;`
	`property Sock: TTCPBlockSocket read FSock;`

Description

Methods

+ + + + + +

constructor Create;

+ + + + + +

destructor Destroy; override;

+ + + + + +

function Login: Boolean;

+Connects to NNTP server and begin session.

+ + + + + +

function Logout: Boolean;

+Logout from NNTP server and terminate session.

+ + + + + +

function DoCommand(const Command: string): boolean;

+By this you can call any NNTP command.

+ + + + + +

function DoCommandRead(const Command: string): boolean;

+by this you can call any NNTP command. This variant is used for commands for download information from server.

+ + + + + +

function DoCommandWrite(const Command: string): boolean;

+by this you can call any NNTP command. This variant is used for commands for upload information to server.

+ + + + + +

function GetArticle(const Value: string): Boolean;

+Download full message to Data property. Value can be number of message or message-id (in brackets).

+ + + + + +

function GetBody(const Value: string): Boolean;

+Download only body of message to Data property. Value can be number of message or message-id (in brackets).

+ + + + + +

function GetHead(const Value: string): Boolean;

+Download only headers of message to Data property. Value can be number of message or message-id (in brackets).

+ + + + + +

function GetStat(const Value: string): Boolean;

+Get message status. Value can be number of message or message-id (in brackets).

+ + + + + +

function SelectGroup(const Value: string): Boolean;

+Select given group.

+ + + + + +

function IHave(const MessID: string): Boolean;

+Tell to server 'I have mesage with given message-ID.' If server need this message, message is uploaded to server.

+ + + + + +

function GotoLast: Boolean;

+Move message pointer to last item in group.

+ + + + + +

function GotoNext: Boolean;

+Move message pointer to next item in group.

+ + + + + +

function ListGroups: Boolean;

+Download to Data property list of all groups on NNTP server.

+ + + + + +

function ListNewGroups(Since: TDateTime): Boolean;

+Download to Data property list of all groups created after given time.

+ + + + + +

function NewArticles(const Group: string; Since: TDateTime): Boolean;

+Download to Data property list of message-ids in given group since given time.

+ + + + + +

function PostArticle: Boolean;

+Upload new article to server. (for new messages by you)

+ + + + + +

function SwitchToSlave: Boolean;

+Tells to remote NNTP server 'I am not NNTP client, but I am another NNTP server'.

+ + + + + +

function Xover(xoStart, xoEnd: string): boolean;

+Call NNTP XOVER command.

+ + + + + +

function StartTLS: Boolean;

+Call STARTTLS command for upgrade connection to SSL/TLS mode.

+ + + + + +

function FindCap(const Value: string): string;

+Try to find given capability in extension list. This list is getted after successful login to NNTP server. If extension capability is not found, then return is empty string.

+ + + + + +

function ListExtensions: Boolean;

+Try get list of server extensions. List is returned in Data property.

Properties

+ + + + + +

property ResultCode: Integer read FResultCode;

+Result code number of last operation.

+ + + + + +

property ResultString: string read FResultString;

+String description of last result code from NNTP server.

+ + + + + +

property Data: TStringList read FData;

+Readed data. (message, etc.)

+ + + + + +

property AutoTLS: Boolean read FAutoTLS Write FAutoTLS;

+If is set to True, then upgrade to SSL/TLS mode after login if remote server support it.

+ + + + + +

property FullSSL: Boolean read FFullSSL Write FFullSSL;

+SSL/TLS mode is used from first contact to server. Servers with full SSL/TLS mode usualy using non-standard TCP port!

+ + + + + +

property Sock: TTCPBlockSocket read FSock;

+Socket object used for TCP/IP operation. Good for seting OnStatus hook, etc.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/nntpsend.html Index: lib/synapse/docs/help/nntpsend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/nntpsend.html @@ -0,0 +1,49 @@ + + + + + +nntpsend + + + +

Unit nntpsend

+ + +

Functions and Procedures

Types

Variables

Description

+NNTP client

+ NNTP (network news transfer protocol) + +

Used RFC: RFC-977, RFC-2980

uses

SysUtils
Classes
blcksock
synautil

Overview

Classes, Interfaces, Objects and Records

+ + + + + + + + + +

Name	Description
Class `TNNTPSend`

Constants

+ + + + +

cNNTPProtocol = '119';

Description

Constants

+ + + + +

cNNTPProtocol = '119';

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/pasdoc.css Index: lib/synapse/docs/help/pasdoc.css ================================================================== --- /dev/null +++ lib/synapse/docs/help/pasdoc.css @@ -0,0 +1,82 @@ +body { font-family: Verdana,Arial; + color: black; background-color: white; + font-size: 12px; } +body.navigationframe { font-family: Verdana,Arial; + color: white; background-color: #787878; + font-size: 12px; } + +img { border:0px; } + +a:link {color:#C91E0C; text-decoration: none; } +a:visited {color:#7E5C31; text-decoration: none; } +a:hover {text-decoration: underline; } +a:active {text-decoration: underline; } + +a.navigation:link { color: white; text-decoration: none; font-size: 12px;} +a.navigation:visited { color: white; text-decoration: none; font-size: 12px;} +a.navigation:hover { color: white; font-weight: bold; + text-decoration: none; font-size: 12px; } +a.navigation:active { color: white; text-decoration: none; font-size: 12px;} + +a.bold:link {color:#C91E0C; text-decoration: none; font-weight:bold; } +a.bold:visited {color:#7E5C31; text-decoration: none; font-weight:bold; } +a.bold:hover {text-decoration: underline; font-weight:bold; } +a.bold:active {text-decoration: underline; font-weight:bold; } + +a.section {color: green; text-decoration: none; font-weight: bold; } +a.section:hover {color: green; text-decoration: underline; font-weight: bold; } + +ul.useslist a:link {color:#C91E0C; text-decoration: none; font-weight:bold; } +ul.useslist a:visited {color:#7E5C31; text-decoration: none; font-weight:bold; } +ul.useslist a:hover {text-decoration: underline; font-weight:bold; } +ul.useslist a:active {text-decoration: underline; font-weight:bold; } + +ul.hierarchy { list-style-type:none; } +ul.hierarchylevel { list-style-type:none; } + +p.unitlink a:link {color:#C91E0C; text-decoration: none; font-weight:bold; } +p.unitlink a:visited {color:#7E5C31; text-decoration: none; font-weight:bold; } +p.unitlink a:hover {text-decoration: underline; font-weight:bold; } +p.unitlink a:active {text-decoration: underline; font-weight:bold; } + +tr.list { background: #FFBF44; } +tr.list2 { background: #FFC982; } +tr.listheader { background: #C91E0C; color: white; } + +table { border-spacing:2px; padding:4px; width:100%; } + +table.markerlegend { width:auto; } +table.markerlegend td.legendmarker { text-align:center; } + +table.sections { background:white; } +table.sections td {background:lightgray; } + +table.summary td.itemcode { width:100%; } +table.detail td.itemcode { width:100%; } + +td { vertical-align:top; padding:4px; } + +td.itemname {white-space:nowrap; } +td.itemunit {white-space:nowrap; } +td.itemdesc { width:100%; } + +div.nodescription {color:red;} +dl.parameters {;} +dl.parameters dt {color:blue;} +dl.parameters dd {;} + +/* Style applied to Pascal code in documentation + (e.g. produced by @longcode tag) } */ +span.pascal_string { color: #000080; } +span.pascal_keyword { font-weight: bolder; } +span.pascal_comment { color: #000080; font-style: italic; } +span.pascal_compiler_comment { color: #008000; } +span.pascal_numeric { } +span.pascal_hex { } + +p.hint_directive { color: red; } + +input#search_text { } +input#search_submit_button { } + +acronym.mispelling { background-color: #ffa; } ADDED lib/synapse/docs/help/pingsend.TPINGSend.html Index: lib/synapse/docs/help/pingsend.TPINGSend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/pingsend.TPINGSend.html @@ -0,0 +1,178 @@ + + + + + +pingsend: Class TPINGSend + + + +

Class TPINGSend

+ + +

Fields

Unit

+pingsend

Declaration

+type TPINGSend = class(TSynaClient)

Description

+Implementation of ICMP PING and ICMPv6 PING.

Hierarchy

TObject
TSynaClient
TPINGSend

Overview

Methods

+ + + + + + + + + + + + + +

	`function Ping(const Host: string): Boolean;`
	`constructor Create;`
	`destructor Destroy; override;`

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`property PacketSize: Integer read FPacketSize Write FPacketSize;`
	`property PingTime: Integer read FPingTime;`
	`property ReplyFrom: string read FReplyFrom;`
	`property ReplyType: byte read FReplyType;`
	`property ReplyCode: byte read FReplyCode;`
	`property ReplyError: TICMPError read FReplyError;`
	`property ReplyErrorDesc: string read FReplyErrorDesc;`
	`property Sock: TICMPBlockSocket read FSock;`
	`property TTL: byte read FTTL write FTTL;`

Description

Methods

+ + + + + +

function Ping(const Host: string): Boolean;

+Send ICMP ping to host and count PingTime. If ping OK, result is True.

+ + + + + +

constructor Create;

+ + + + + +

destructor Destroy; override;

Properties

+ + + + + +

property PacketSize: Integer read FPacketSize Write FPacketSize;

+Size of PING packet. Default size is 32 bytes.

+ + + + + +

property PingTime: Integer read FPingTime;

+Time between request and reply.

+ + + + + +

property ReplyFrom: string read FReplyFrom;

+From this address is sended reply for your PING request. It maybe not your requested destination, when some error occured!

+ + + + + +

property ReplyType: byte read FReplyType;

+ICMP type of PING reply. Each protocol using another values! For IPv4 and IPv6 are used different values!

+ + + + + +

property ReplyCode: byte read FReplyCode;

+ICMP code of PING reply. Each protocol using another values! For IPv4 and IPv6 are used different values! For protocol independent value look to ReplyError

+ + + + + +

property ReplyError: TICMPError read FReplyError;

+Return type of returned ICMP message. This value is independent on used protocol!

+ + + + + +

property ReplyErrorDesc: string read FReplyErrorDesc;

+Return human readable description of returned packet type.

+ + + + + +

property Sock: TICMPBlockSocket read FSock;

+Socket object used for TCP/IP operation. Good for seting OnStatus hook, etc.

+ + + + + +

property TTL: byte read FTTL write FTTL;

+TTL value for ICMP query

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/pingsend.html Index: lib/synapse/docs/help/pingsend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/pingsend.html @@ -0,0 +1,155 @@ + + + + + +pingsend + + + +

Unit pingsend

+ + +

Variables

Description

uses

SysUtils
synsock
blcksock
synautil
synafpc
synaip
windows

Overview

Classes, Interfaces, Objects and Records

+ + + + + + + + + +

Name	Description
Class `TPINGSend`	Implementation of ICMP PING and ICMPv6 PING.

Functions and Procedures

+ + + + + + + +

function PingHost(const Host: string): Integer;

function TraceRouteHost(const Host: string): string;

Types

+ + + + +

TICMPError = (...);

Constants

+ + + + + + + + + + + + + + + + + + + + + + + + + +

ICMP_ECHO = 8;

ICMP_ECHOREPLY = 0;

ICMP_UNREACH = 3;

ICMP_TIME_EXCEEDED = 11;

ICMP6_ECHO = 128;

ICMP6_ECHOREPLY = 129;

ICMP6_UNREACH = 1;

ICMP6_TIME_EXCEEDED = 3;

Description

Functions and Procedures

+ + + + +

function PingHost(const Host: string): Integer;

+A very useful function and example of its use would be found in the TPINGSend object. Use it to ping to any host. If successful, returns the ping time in milliseconds. Returns -1 if an error occurred.

+ + + + +

function TraceRouteHost(const Host: string): string;

+A very useful function and example of its use would be found in the TPINGSend object. Use it to TraceRoute to any host.

Types

+ + + + +

TICMPError = (...);

+List of possible ICMP reply packet types.

+IE_NoError:
+IE_Other:
+IE_TTLExceed:
+IE_UnreachOther:
+IE_UnreachRoute:
+IE_UnreachAdmin:
+IE_UnreachAddr:
+IE_UnreachPort:

Constants

+ + + + +

ICMP_ECHO = 8;

+ + + + +

ICMP_ECHOREPLY = 0;

+ + + + +

ICMP_UNREACH = 3;

+ + + + +

ICMP_TIME_EXCEEDED = 11;

+ + + + +

ICMP6_ECHO = 128;

+ + + + +

ICMP6_ECHOREPLY = 129;

+ + + + +

ICMP6_UNREACH = 1;

+ + + + +

ICMP6_TIME_EXCEEDED = 3;

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/pop3send.TPOP3Send.html Index: lib/synapse/docs/help/pop3send.TPOP3Send.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/pop3send.TPOP3Send.html @@ -0,0 +1,378 @@ + + + + + +pop3send: Class TPOP3Send + + + +

Class TPOP3Send

+ + +

Fields

Unit

+pop3send

Declaration

+type TPOP3Send = class(TSynaClient)

Description

+Implementation of POP3 client protocol.

+ + +

Note: Are you missing properties for setting Username and Password? Look to parent TSynaClient object! + +

Are you missing properties for specify server address and port? Look to parent TSynaClient too!

Hierarchy

TObject
TSynaClient
TPOP3Send

Overview

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`constructor Create;`
	`destructor Destroy; override;`
	`function CustomCommand(const Command: string; MultiLine: Boolean): boolean;`
	`function Capability: Boolean;`
	`function Login: Boolean;`
	`function Logout: Boolean;`
	`function Reset: Boolean;`
	`function NoOp: Boolean;`
	`function Stat: Boolean;`
	`function List(Value: Integer): Boolean;`
	`function Retr(Value: Integer): Boolean;`
	`function RetrStream(Value: Integer; Stream: TStream): Boolean;`
	`function Dele(Value: Integer): Boolean;`
	`function Top(Value, Maxlines: Integer): Boolean;`
	`function Uidl(Value: Integer): Boolean;`
	`function StartTLS: Boolean;`
	`function FindCap(const Value: string): string;`

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`property ResultCode: Integer read FResultCode;`
	`property ResultString: string read FResultString;`
	`property FullResult: TStringList read FFullResult;`
	`property StatCount: Integer read FStatCount;`
	`property StatSize: Integer read FStatSize;`
	`property ListSize: Integer read FListSize;`
	`property TimeStamp: string read FTimeStamp;`
	`property AuthType: TPOP3AuthType read FAuthType Write FAuthType;`
	`property AutoTLS: Boolean read FAutoTLS Write FAutoTLS;`
	`property FullSSL: Boolean read FFullSSL Write FFullSSL;`
	`property Sock: TTCPBlockSocket read FSock;`

Description

Methods

+ + + + + +

constructor Create;

+ + + + + +

destructor Destroy; override;

+ + + + + +

function CustomCommand(const Command: string; MultiLine: Boolean): boolean;

+You can call any custom by this method. Call Command without trailing CRLF. If MultiLine parameter is True, multilined response are expected. Result is True on sucess.

+ + + + + +

function Capability: Boolean;

+Call CAPA command for get POP3 server capabilites. note: not all servers support this command!

+ + + + + +

function Login: Boolean;

+Connect to remote POP3 host. If all OK, result is True.

+ + + + + +

function Logout: Boolean;

+Disconnects from POP3 server.

+ + + + + +

function Reset: Boolean;

+Send RSET command. If all OK, result is True.

+ + + + + +

function NoOp: Boolean;

+Send NOOP command. If all OK, result is True.

+ + + + + +

function Stat: Boolean;

+Send STAT command and fill StatCount and StatSize property. If all OK, result is True.

+ + + + + +

function List(Value: Integer): Boolean;

+Send LIST command. If Value is 0, LIST is for all messages. After successful operation is listing in FullResult. If all OK, result is True.

+ + + + + +

function Retr(Value: Integer): Boolean;

+Send RETR command. After successful operation dowloaded message in FullResult. If all OK, result is True.

+ + + + + +

function RetrStream(Value: Integer; Stream: TStream): Boolean;

+Send RETR command. After successful operation dowloaded message in Stream. If all OK, result is True.

+ + + + + +

function Dele(Value: Integer): Boolean;

+Send DELE command for delete specified message. If all OK, result is True.

+ + + + + +

function Top(Value, Maxlines: Integer): Boolean;

+Send TOP command. After successful operation dowloaded headers of message and maxlines count of message in FullResult. If all OK, result is True.

+ + + + + +

function Uidl(Value: Integer): Boolean;

+Send UIDL command. If Value is 0, UIDL is for all messages. After successful operation is listing in FullResult. If all OK, result is True.

+ + + + + +

function StartTLS: Boolean;

+Call STLS command for upgrade connection to SSL/TLS mode.

+ + + + + +

function FindCap(const Value: string): string;

+Try to find given capabily in capabilty string returned from POP3 server by CAPA command.

Properties

+ + + + + +

property ResultCode: Integer read FResultCode;

+Result code of last POP3 operation. 0 - error, 1 - OK.

+ + + + + +

property ResultString: string read FResultString;

+Result string of last POP3 operation.

+ + + + + +

property FullResult: TStringList read FFullResult;

+Stringlist with full lines returned as result of POP3 operation. I.e. if operation is LIST, this property is filled by list of messages. If operation is RETR, this property have downloaded message.

+ + + + + +

property StatCount: Integer read FStatCount;

+After STAT command is there count of messages in inbox.

+ + + + + +

property StatSize: Integer read FStatSize;

+After STAT command is there size of all messages in inbox.

+ + + + + +

property ListSize: Integer read FListSize;

+After LIST 0 command size of all messages on server, After LIST x size of message x on server

+ + + + + +

property TimeStamp: string read FTimeStamp;

+If server support this, after comnnect is in this property timestamp of remote server.

+ + + + + +

property AuthType: TPOP3AuthType read FAuthType Write FAuthType;

+Type of authorisation for login to POP3 server. Dafault is autodetect one of possible authorisation. Autodetect do this: + +

If remote POP3 server support APOP, try login by APOP method. If APOP is not supported, or if APOP login failed, try classic USER+PASS login method.

+ + + + + +

property AutoTLS: Boolean read FAutoTLS Write FAutoTLS;

+If is set to True, then upgrade to SSL/TLS mode if remote server support it.

+ + + + + +

property FullSSL: Boolean read FFullSSL Write FFullSSL;

+SSL/TLS mode is used from first contact to server. Servers with full SSL/TLS mode usualy using non-standard TCP port!

+ + + + + +

property Sock: TTCPBlockSocket read FSock;

+Socket object used for TCP/IP operation. Good for seting OnStatus hook, etc.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/pop3send.html Index: lib/synapse/docs/help/pop3send.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/pop3send.html @@ -0,0 +1,71 @@ + + + + + +pop3send + + + +

Unit pop3send

+ + +

Functions and Procedures

Variables

Description

+POP3 protocol client

+ + +

Used RFC: RFC-1734, RFC-1939, RFC-2195, RFC-2449, RFC-2595

uses

SysUtils
Classes
blcksock
synautil
synacode

Overview

Classes, Interfaces, Objects and Records

+ + + + + + + + + +

Name	Description
Class `TPOP3Send`	Implementation of POP3 client protocol.

Types

+ + + + +

TPOP3AuthType = (...);

Constants

+ + + + +

cPop3Protocol = '110';

Description

Types

+ + + + +

TPOP3AuthType = (...);

+The three types of possible authorization methods for "logging in" to a POP3 server.

+POP3AuthAll:
+POP3AuthLogin:
+POP3AuthAPOP:

Constants

+ + + + +

cPop3Protocol = '110';

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/private.gif Index: lib/synapse/docs/help/private.gif ================================================================== --- /dev/null +++ lib/synapse/docs/help/private.gif cannot compute difference between binary files ADDED lib/synapse/docs/help/protected.gif Index: lib/synapse/docs/help/protected.gif ================================================================== --- /dev/null +++ lib/synapse/docs/help/protected.gif cannot compute difference between binary files ADDED lib/synapse/docs/help/public.gif Index: lib/synapse/docs/help/public.gif ================================================================== --- /dev/null +++ lib/synapse/docs/help/public.gif cannot compute difference between binary files ADDED lib/synapse/docs/help/published.gif Index: lib/synapse/docs/help/published.gif ================================================================== --- /dev/null +++ lib/synapse/docs/help/published.gif cannot compute difference between binary files ADDED lib/synapse/docs/help/slogsend.TSyslogMessage.html Index: lib/synapse/docs/help/slogsend.TSyslogMessage.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/slogsend.TSyslogMessage.html @@ -0,0 +1,133 @@ + + + + + +slogsend: Class TSyslogMessage + + + +

Class TSyslogMessage

+ + +

Fields

Unit

+slogsend

Declaration

+type TSyslogMessage = class(TObject)

Description

+encoding or decoding of SYSLOG message

Hierarchy

TObject
TSyslogMessage

Overview

Methods

+ + + + + +

procedure Clear;

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`property Facility: Byte read FFacility write FFacility;`
	`property Severity: TSyslogSeverity read FSeverity write FSeverity;`
	`property DateTime: TDateTime read FDateTime write FDateTime;`
	`property Tag: String read FTag write FTag;`
	`property LogMessage: String read FMessage write FMessage;`
	`property LocalIP: String read FLocalIP write FLocalIP;`
	`property PacketBuf: String read GetPacketBuf write SetPacketBuf;`

Description

Methods

+ + + + + +

procedure Clear;

+Reset values to defaults

Properties

+ + + + + +

property Facility: Byte read FFacility write FFacility;

+Define facilicity of Syslog message. For specify you may use predefined FCL_* constants. Default is "FCL_Local0".

+ + + + + +

property Severity: TSyslogSeverity read FSeverity write FSeverity;

+Define possible priority of Syslog message. Default is "Debug".

+ + + + + +

property DateTime: TDateTime read FDateTime write FDateTime;

+date and time of Syslog message

+ + + + + +

property Tag: String read FTag write FTag;

+This is used for identify process of this message. Default is filename of your executable file.

+ + + + + +

property LogMessage: String read FMessage write FMessage;

+Text of your message for log.

+ + + + + +

property LocalIP: String read FLocalIP write FLocalIP;

+IP address of message sender.

+ + + + + +

property PacketBuf: String read GetPacketBuf write SetPacketBuf;

+This property holds encoded binary SYSLOG packet

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/slogsend.TSyslogSend.html Index: lib/synapse/docs/help/slogsend.TSyslogSend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/slogsend.TSyslogSend.html @@ -0,0 +1,86 @@ + + + + + +slogsend: Class TSyslogSend + + + +

Class TSyslogSend

+ + +

Fields

Unit

+slogsend

Declaration

+type TSyslogSend = class(TSynaClient)

Description

+This object implement BSD SysLog client

+ + +

Note: Are you missing properties for specify server address and port? Look to parent TSynaClient too!

Hierarchy

TObject
TSynaClient
TSyslogSend

Overview

Methods

+ + + + + + + + + + + + + +

	`constructor Create;`
	`destructor Destroy; override;`
	`function DoIt: Boolean;`

Properties

+ + + + + +

property SysLogMessage: TSysLogMessage read FSysLogMessage write FSysLogMessage;

Description

Methods

+ + + + + +

constructor Create;

+ + + + + +

destructor Destroy; override;

+ + + + + +

function DoIt: Boolean;

+Send Syslog UDP packet defined by SysLogMessage.

Properties

+ + + + + +

property SysLogMessage: TSysLogMessage read FSysLogMessage write FSysLogMessage;

+Syslog message for send

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/slogsend.html Index: lib/synapse/docs/help/slogsend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/slogsend.html @@ -0,0 +1,291 @@ + + + + + +slogsend + + + +

Unit slogsend

+ + +

Variables

Description

+BSD SYSLOG protocol

+ + +

Used RFC: RFC-3164

uses

SysUtils
Classes
blcksock
synautil

Overview

Classes, Interfaces, Objects and Records

+ + + + + + + + + + + + + +

Name	Description
Class `TSyslogMessage`	encoding or decoding of SYSLOG message
Class `TSyslogSend`	This object implement BSD SysLog client

Functions and Procedures

+ + + + +

function ToSysLog(const SyslogServer: string; Facil: Byte; Sever: TSyslogSeverity; const Content: string): Boolean;

Types

+ + + + +

TSyslogSeverity = (...);

Constants

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

cSysLogProtocol = '514';

FCL_Kernel = 0;

FCL_UserLevel = 1;

FCL_MailSystem = 2;

FCL_System = 3;

FCL_Security = 4;

FCL_Syslogd = 5;

FCL_Printer = 6;

FCL_News = 7;

FCL_UUCP = 8;

FCL_Clock = 9;

FCL_Authorization = 10;

FCL_FTP = 11;

FCL_NTP = 12;

FCL_LogAudit = 13;

FCL_LogAlert = 14;

FCL_Time = 15;

FCL_Local0 = 16;

FCL_Local1 = 17;

FCL_Local2 = 18;

FCL_Local3 = 19;

FCL_Local4 = 20;

FCL_Local5 = 21;

FCL_Local6 = 22;

FCL_Local7 = 23;

Description

Functions and Procedures

+ + + + +

function ToSysLog(const SyslogServer: string; Facil: Byte; Sever: TSyslogSeverity; const Content: string): Boolean;

+Simply send packet to specified Syslog server.

Types

+ + + + +

TSyslogSeverity = (...);

+Define possible priority of Syslog message

+Emergency:
+Alert:
+Critical:
+Error:
+Warning:
+Notice:
+Info:
+Debug:

Constants

+ + + + +

cSysLogProtocol = '514';

+ + + + +

FCL_Kernel = 0;

+ + + + +

FCL_UserLevel = 1;

+ + + + +

FCL_MailSystem = 2;

+ + + + +

FCL_System = 3;

+ + + + +

FCL_Security = 4;

+ + + + +

FCL_Syslogd = 5;

+ + + + +

FCL_Printer = 6;

+ + + + +

FCL_News = 7;

+ + + + +

FCL_UUCP = 8;

+ + + + +

FCL_Clock = 9;

+ + + + +

FCL_Authorization = 10;

+ + + + +

FCL_FTP = 11;

+ + + + +

FCL_NTP = 12;

+ + + + +

FCL_LogAudit = 13;

+ + + + +

FCL_LogAlert = 14;

+ + + + +

FCL_Time = 15;

+ + + + +

FCL_Local0 = 16;

+ + + + +

FCL_Local1 = 17;

+ + + + +

FCL_Local2 = 18;

+ + + + +

FCL_Local3 = 19;

+ + + + +

FCL_Local4 = 20;

+ + + + +

FCL_Local5 = 21;

+ + + + +

FCL_Local6 = 22;

+ + + + +

FCL_Local7 = 23;

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/smtpsend.TSMTPSend.html Index: lib/synapse/docs/help/smtpsend.TSMTPSend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/smtpsend.TSMTPSend.html @@ -0,0 +1,390 @@ + + + + + +smtpsend: Class TSMTPSend + + + +

Class TSMTPSend

+ + +

Fields

Unit

+smtpsend

Declaration

+type TSMTPSend = class(TSynaClient)

Description

+Implementation of SMTP and ESMTP procotol

+, include some ESMTP extensions, include SSL/TLS too. + +

Note: Are you missing properties for setting Username and Password for ESMTP? Look to parent TSynaClient object! + +

Are you missing properties for specify server address and port? Look to parent TSynaClient too!

Hierarchy

TObject
TSynaClient
TSMTPSend

Overview

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`constructor Create;`
	`destructor Destroy; override;`
	`function Login: Boolean;`
	`function Logout: Boolean;`
	`function Reset: Boolean;`
	`function NoOp: Boolean;`
	`function MailFrom(const Value: string; Size: Integer): Boolean;`
	`function MailTo(const Value: string): Boolean;`
	`function MailData(const Value: Tstrings): Boolean;`
	`function Etrn(const Value: string): Boolean;`
	`function Verify(const Value: string): Boolean;`
	`function StartTLS: Boolean;`
	`function EnhCodeString: string;`
	`function FindCap(const Value: string): string;`

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`property ResultCode: Integer read FResultCode;`
	`property ResultString: string read FResultString;`
	`property FullResult: TStringList read FFullResult;`
	`property ESMTPcap: TStringList read FESMTPcap;`
	`property ESMTP: Boolean read FESMTP;`
	`property AuthDone: Boolean read FAuthDone;`
	`property ESMTPSize: Boolean read FESMTPSize;`
	`property MaxSize: Integer read FMaxSize;`
	`property EnhCode1: Integer read FEnhCode1;`
	`property EnhCode2: Integer read FEnhCode2;`
	`property EnhCode3: Integer read FEnhCode3;`
	`property SystemName: string read FSystemName Write FSystemName;`
	`property AutoTLS: Boolean read FAutoTLS Write FAutoTLS;`
	`property FullSSL: Boolean read FFullSSL Write FFullSSL;`
	`property Sock: TTCPBlockSocket read FSock;`

Description

Methods

+ + + + + +

constructor Create;

+ + + + + +

destructor Destroy; override;

+ + + + + +

function Login: Boolean;

+Connects to SMTP server (defined in TSynaClient.TargetHost) and begin SMTP session. (First try ESMTP EHLO, next old HELO handshake). Parses ESMTP capabilites and if you specified Username and password and remote server can handle AUTH command, try login by AUTH command. Preffered login method is CRAM-MD5 (if safer!). If all OK, result is True, else result is False.

+ + + + + +

function Logout: Boolean;

+Close SMTP session (QUIT command) and disconnect from SMTP server.

+ + + + + +

function Reset: Boolean;

+Send RSET SMTP command for reset SMTP session. If all OK, result is True, else result is False.

+ + + + + +

function NoOp: Boolean;

+Send NOOP SMTP command for keep SMTP session. If all OK, result is True, else result is False.

+ + + + + +

function MailFrom(const Value: string; Size: Integer): Boolean;

+Send MAIL FROM SMTP command for set sender e-mail address. If sender's e-mail address is empty string, transmited message is error message. + +

If size not 0 and remote server can handle SIZE parameter, append SIZE parameter to request. If all OK, result is True, else result is False.

+ + + + + +

function MailTo(const Value: string): Boolean;

+Send RCPT TO SMTP command for set receiver e-mail address. It cannot be an empty string. If all OK, result is True, else result is False.

+ + + + + +

function MailData(const Value: Tstrings): Boolean;

+Send DATA SMTP command and transmit message data. If all OK, result is True, else result is False.

+ + + + + +

function Etrn(const Value: string): Boolean;

+Send ETRN SMTP command for start sending of remote queue for domain in Value. If all OK, result is True, else result is False.

+ + + + + +

function Verify(const Value: string): Boolean;

+Send VRFY SMTP command for check receiver e-mail address. It cannot be an empty string. If all OK, result is True, else result is False.

+ + + + + +

function StartTLS: Boolean;

+Call STARTTLS command for upgrade connection to SSL/TLS mode.

+ + + + + +

function EnhCodeString: string;

+Return string descriptive text for enhanced result codes stored in EnhCode1, EnhCode2 and EnhCode3.

+ + + + + +

function FindCap(const Value: string): string;

+Try to find specified capability in ESMTP response.

Properties

+ + + + + +

property ResultCode: Integer read FResultCode;

+result code of last SMTP command.

+ + + + + +

property ResultString: string read FResultString;

+result string of last SMTP command (begin with string representation of result code).

+ + + + + +

property FullResult: TStringList read FFullResult;

+All result strings of last SMTP command (result is maybe multiline!).

+ + + + + +

property ESMTPcap: TStringList read FESMTPcap;

+List of ESMTP capabilites of remote ESMTP server. (If you connect to ESMTP server only!).

+ + + + + +

property ESMTP: Boolean read FESMTP;

+True if you successfuly logged to ESMTP server.

+ + + + + +

property AuthDone: Boolean read FAuthDone;

+True if you successfuly pass authorisation to remote server.

+ + + + + +

property ESMTPSize: Boolean read FESMTPSize;

+True if remote server can handle SIZE parameter.

+ + + + + +

property MaxSize: Integer read FMaxSize;

+When ESMTPSize is True, contains max length of message that remote server can handle.

+ + + + + +

property EnhCode1: Integer read FEnhCode1;

+First digit of Enhanced result code. If last operation does not have enhanced result code, values is 0.

+ + + + + +

property EnhCode2: Integer read FEnhCode2;

+Second digit of Enhanced result code. If last operation does not have enhanced result code, values is 0.

+ + + + + +

property EnhCode3: Integer read FEnhCode3;

+Third digit of Enhanced result code. If last operation does not have enhanced result code, values is 0.

+ + + + + +

property SystemName: string read FSystemName Write FSystemName;

+name of our system used in HELO and EHLO command. Implicit value is internet address of your machine.

+ + + + + +

property AutoTLS: Boolean read FAutoTLS Write FAutoTLS;

+If is set to true, then upgrade to SSL/TLS mode if remote server support it.

+ + + + + +

property FullSSL: Boolean read FFullSSL Write FFullSSL;

+SSL/TLS mode is used from first contact to server. Servers with full SSL/TLS mode usualy using non-standard TCP port!

+ + + + + +

property Sock: TTCPBlockSocket read FSock;

+Socket object used for TCP/IP operation. Good for seting OnStatus hook, etc.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/smtpsend.html Index: lib/synapse/docs/help/smtpsend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/smtpsend.html @@ -0,0 +1,95 @@ + + + + + +smtpsend + + + +

Unit smtpsend

+ + +

Types

Variables

Description

+SMTP client

+ + +

Used RFC: RFC-1869, RFC-1870, RFC-1893, RFC-2034, RFC-2104, RFC-2195, RFC-2487, RFC-2554, RFC-2821

uses

SysUtils
Classes
blcksock
synautil
synacode

Overview

Classes, Interfaces, Objects and Records

+ + + + + + + + + +

Name	Description
Class `TSMTPSend`	Implementation of SMTP and ESMTP procotol

Functions and Procedures

+ + + + + + + + + + +

function SendToRaw(const MailFrom, MailTo, SMTPHost: string; const MailData: TStrings; const Username, Password: string): Boolean;

function SendTo(const MailFrom, MailTo, Subject, SMTPHost: string; const MailData: TStrings): Boolean;

function SendToEx(const MailFrom, MailTo, Subject, SMTPHost: string; const MailData: TStrings; const Username, Password: string): Boolean;

Constants

+ + + + +

cSmtpProtocol = '25';

Description

Functions and Procedures

+ + + + +

function SendToRaw(const MailFrom, MailTo, SMTPHost: string; const MailData: TStrings; const Username, Password: string): Boolean;

+A very useful function and example of its use would be found in the TSMTPsend object. Send maildata (text of e-mail with all SMTP headers! For example when text of message is created by TMimeMess object) from "MailFrom" e-mail address to "MailTo" e-mail address (If you need more then one receiver, then separate their addresses by comma). + +

Function sends e-mail to a SMTP server defined in "SMTPhost" parameter. Username and password are used for authorization to the "SMTPhost". If you don't want authorization, set "Username" and "Password" to empty strings. If e-mail message is successfully sent, the result returns True. + +

If you need use different port number then standard, then add this port number to SMTPhost after colon. (i.e. '127.0.0.1:1025')

+ + + + +

function SendTo(const MailFrom, MailTo, Subject, SMTPHost: string; const MailData: TStrings): Boolean;

+A very useful function and example of its use would be found in the TSMTPsend object. Send "Maildata" (text of e-mail without any SMTP headers!) from "MailFrom" e-mail address to "MailTo" e-mail address with "Subject". (If you need more then one receiver, then separate their addresses by comma). + +

This function constructs all needed SMTP headers (with DATE header) and sends the e-mail to the SMTP server defined in the "SMTPhost" parameter. If the e-mail message is successfully sent, the result will be True. + +

If you need use different port number then standard, then add this port number to SMTPhost after colon. (i.e. '127.0.0.1:1025')

+ + + + +

function SendToEx(const MailFrom, MailTo, Subject, SMTPHost: string; const MailData: TStrings; const Username, Password: string): Boolean;

+A very useful function and example of its use would be found in the TSMTPsend object. Sends "MailData" (text of e-mail without any SMTP headers!) from "MailFrom" e-mail address to "MailTo" e-mail address (If you need more then one receiver, then separate their addresses by comma). + +

This function sends the e-mail to the SMTP server defined in the "SMTPhost" parameter. Username and password are used for authorization to the "SMTPhost". If you dont want authorization, set "Username" and "Password" to empty Strings. If the e-mail message is successfully sent, the result will be True. + +

If you need use different port number then standard, then add this port number to SMTPhost after colon. (i.e. '127.0.0.1:1025')

Constants

+ + + + +

cSmtpProtocol = '25';

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/snmpsend.TSNMPMib.html Index: lib/synapse/docs/help/snmpsend.TSNMPMib.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/snmpsend.TSNMPMib.html @@ -0,0 +1,69 @@ + + + + + +snmpsend: Class TSNMPMib + + + +

Class TSNMPMib

+ + +

Fields

Methods

Properties

Unit

Declaration

+type TSNMPMib = class(TObject)

Description

+Data object with one record of MIB OID and corresponding values.

Hierarchy

TObject
TSNMPMib

Overview

Properties

+ + + + + + + + + + + + + +

	`property OID: AnsiString read FOID write FOID;`
	`property Value: AnsiString read FValue write FValue;`
	`property ValueType: Integer read FValueType write FValueType;`

Description

Properties

+ + + + + +

property OID: AnsiString read FOID write FOID;

+OID number in string format.

+ + + + + +

property Value: AnsiString read FValue write FValue;

+Value of OID object in string format.

+ + + + + +

property ValueType: Integer read FValueType write FValueType;

+Define type of Value. Supported values are defined in asn1util. For queries use ASN1_NULL, becouse you don't know type in response!

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/snmpsend.TSNMPRec.html Index: lib/synapse/docs/help/snmpsend.TSNMPRec.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/snmpsend.TSNMPRec.html @@ -0,0 +1,513 @@ + + + + + +snmpsend: Class TSNMPRec + + + +

Class TSNMPRec

+ + +

Fields

Unit

Declaration

+type TSNMPRec = class(TObject)

Description

+Data object abstracts SNMP data packet

Hierarchy

TObject
TSNMPRec

Overview

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`constructor Create;`
	`destructor Destroy; override;`
	`function DecodeBuf(Buffer: AnsiString): Boolean;`
	`function EncodeBuf: AnsiString;`
	`procedure Clear;`
	`procedure MIBAdd(const MIB, Value: AnsiString; ValueType: Integer);`
	`procedure MIBDelete(Index: Integer);`
	`function MIBGet(const MIB: AnsiString): AnsiString;`
	`function MIBCount: integer;`
	`function MIBByIndex(Index: Integer): TSNMPMib;`

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`property SNMPMibList: TList read FSNMPMibList;`
	`property Version: Integer read FVersion write FVersion;`
	`property Community: AnsiString read FCommunity write FCommunity;`
	`property PDUType: Integer read FPDUType write FPDUType;`
	`property ID: Integer read FID write FID;`
	`property ErrorStatus: Integer read FErrorStatus write FErrorStatus;`
	`property ErrorIndex: Integer read FErrorIndex write FErrorIndex;`
	`property NonRepeaters: Integer read FErrorStatus write FErrorStatus;`
	`property MaxRepetitions: Integer read FErrorIndex write FErrorIndex;`
	`property MaxSize: Integer read FMaxSize write FMaxSize;`
	`property Flags: TV3Flags read FFlags write FFlags;`
	`property FlagReportable: Boolean read FFlagReportable write FFlagReportable;`
	`property ContextEngineID: AnsiString read FContextEngineID write FContextEngineID;`
	`property ContextName: AnsiString read FContextName write FContextName;`
	`property AuthMode: TV3Auth read FAuthMode write FAuthMode;`
	`property PrivMode: TV3Priv read FPrivMode write FPrivMode;`
	`property AuthEngineID: AnsiString read FAuthEngineID write FAuthEngineID;`
	`property AuthEngineBoots: Integer read FAuthEngineBoots write FAuthEngineBoots;`
	`property AuthEngineTime: Integer read FAuthEngineTime write FAuthEngineTime;`
	`property AuthEngineTimeStamp: Cardinal read FAuthEngineTimeStamp Write FAuthEngineTimeStamp;`
	`property UserName: AnsiString read FUserName write FUserName;`
	`property Password: AnsiString read FPassword write FPassword;`
	`property AuthKey: AnsiString read FAuthKey write FAuthKey;`
	`property PrivPassword: AnsiString read FPrivPassword write FPrivPassword;`
	`property PrivKey: AnsiString read FPrivKey write FPrivKey;`
	`property OldTrapEnterprise: AnsiString read FOldTrapEnterprise write FOldTrapEnterprise;`
	`property OldTrapHost: AnsiString read FOldTrapHost write FOldTrapHost;`
	`property OldTrapGen: Integer read FOldTrapGen write FOldTrapGen;`
	`property OldTrapSpec: Integer read FOldTrapSpec write FOldTrapSpec;`
	`property OldTrapTimeTicks: Integer read FOldTrapTimeTicks write FOldTrapTimeTicks;`

Description

Methods

+ + + + + +

constructor Create;

+ + + + + +

destructor Destroy; override;

+ + + + + +

function DecodeBuf(Buffer: AnsiString): Boolean;

+Decode SNMP packet in buffer to object properties.

+ + + + + +

function EncodeBuf: AnsiString;

+Encode obeject properties to SNMP packet.

+ + + + + +

procedure Clear;

+Clears all object properties to default values.

+ + + + + +

procedure MIBAdd(const MIB, Value: AnsiString; ValueType: Integer);

+Add entry to SNMPMibList. For queries use value as empty string, and ValueType as ASN1_NULL.

+ + + + + +

procedure MIBDelete(Index: Integer);

+Delete entry from SNMPMibList.

+ + + + + +

function MIBGet(const MIB: AnsiString): AnsiString;

+Search SNMPMibList list for MIB and return correspond value.

+ + + + + +

function MIBCount: integer;

+return number of entries in MIB array.

+ + + + + +

function MIBByIndex(Index: Integer): TSNMPMib;

+Return MIB information from given row of MIB array.

Properties

+ + + + + +

property SNMPMibList: TList read FSNMPMibList;

+List of TSNMPMib objects.

+ + + + + +

property Version: Integer read FVersion write FVersion;

+Version of SNMP packet. Default value is 0 (SNMP ver. 1). You can use value 1 for SNMPv2c or value 3 for SNMPv3.

+ + + + + +

property Community: AnsiString read FCommunity write FCommunity;

+Community string for autorize access to SNMP server. (Case sensitive!) Community string is not used in SNMPv3! Use UserName and Password instead!

+ + + + + +

property PDUType: Integer read FPDUType write FPDUType;

+Define type of SNMP operation.

+ + + + + +

property ID: Integer read FID write FID;

+Contains ID number. Not need to use.

+ + + + + +

property ErrorStatus: Integer read FErrorStatus write FErrorStatus;

+When packet is reply, contains error code. Supported values are defined by E* constants.

+ + + + + +

property ErrorIndex: Integer read FErrorIndex write FErrorIndex;

+Point to error position in reply packet. Not usefull for users. It only good for debugging!

+ + + + + +

property NonRepeaters: Integer read FErrorStatus write FErrorStatus;

+special value for GetBulkRequest of SNMPv2 and v3.

+ + + + + +

property MaxRepetitions: Integer read FErrorIndex write FErrorIndex;

+special value for GetBulkRequest of SNMPv2 and v3.

+ + + + + +

property MaxSize: Integer read FMaxSize write FMaxSize;

+Maximum message size in bytes for SNMPv3. For sending is default 1472 bytes.

+ + + + + +

property Flags: TV3Flags read FFlags write FFlags;

+Specify if message is authorised or encrypted. Used only in SNMPv3.

+ + + + + +

property FlagReportable: Boolean read FFlagReportable write FFlagReportable;

+For SNMPv3.... If is True, SNMP agent must send reply (at least with some error).

+ + + + + +

property ContextEngineID: AnsiString read FContextEngineID write FContextEngineID;

+For SNMPv3. If not specified, is used value from AuthEngineID

+ + + + + +

property ContextName: AnsiString read FContextName write FContextName;

+For SNMPv3.

+ + + + + +

property AuthMode: TV3Auth read FAuthMode write FAuthMode;

+For SNMPv3. Specify Authorization mode. (specify used hash for authorization)

+ + + + + +

property PrivMode: TV3Priv read FPrivMode write FPrivMode;

+For SNMPv3. Specify Privacy mode.

+ + + + + +

property AuthEngineID: AnsiString read FAuthEngineID write FAuthEngineID;

+value used by SNMPv3 authorisation for synchronization with SNMP agent.

+ + + + + +

property AuthEngineBoots: Integer read FAuthEngineBoots write FAuthEngineBoots;

+value used by SNMPv3 authorisation for synchronization with SNMP agent.

+ + + + + +

property AuthEngineTime: Integer read FAuthEngineTime write FAuthEngineTime;

+value used by SNMPv3 authorisation for synchronization with SNMP agent.

+ + + + + +

property AuthEngineTimeStamp: Cardinal read FAuthEngineTimeStamp Write FAuthEngineTimeStamp;

+value used by SNMPv3 authorisation for synchronization with SNMP agent.

+ + + + + +

property UserName: AnsiString read FUserName write FUserName;

+SNMPv3 authorization username

+ + + + + +

property Password: AnsiString read FPassword write FPassword;

+SNMPv3 authorization password

+ + + + + +

property AuthKey: AnsiString read FAuthKey write FAuthKey;

+For SNMPv3. Computed Athorization key from Password.

+ + + + + +

property PrivPassword: AnsiString read FPrivPassword write FPrivPassword;

+SNMPv3 privacy password

+ + + + + +

property PrivKey: AnsiString read FPrivKey write FPrivKey;

+For SNMPv3. Computed Privacy key from PrivPassword.

+ + + + + +

property OldTrapEnterprise: AnsiString read FOldTrapEnterprise write FOldTrapEnterprise;

+MIB value to identify the object that sent the TRAPv1.

+ + + + + +

property OldTrapHost: AnsiString read FOldTrapHost write FOldTrapHost;

+Address of TRAPv1 sender (IP address).

+ + + + + +

property OldTrapGen: Integer read FOldTrapGen write FOldTrapGen;

+Generic TRAPv1 identification.

+ + + + + +

property OldTrapSpec: Integer read FOldTrapSpec write FOldTrapSpec;

+Specific TRAPv1 identification.

+ + + + + +

property OldTrapTimeTicks: Integer read FOldTrapTimeTicks write FOldTrapTimeTicks;

+Number of 1/100th of seconds since last reboot or power up. (for TRAPv1)

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/snmpsend.TSNMPSend.html Index: lib/synapse/docs/help/snmpsend.TSNMPSend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/snmpsend.TSNMPSend.html @@ -0,0 +1,170 @@ + + + + + +snmpsend: Class TSNMPSend + + + +

Class TSNMPSend

+ + +

Fields

Unit

Declaration

+type TSNMPSend = class(TSynaClient)

Description

+Implementation of SNMP protocol.

+ + +

Note: Are you missing properties for specify server address and port? Look to parent TSynaClient too!

Hierarchy

TObject
TSynaClient
TSNMPSend

Overview

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + +

	`constructor Create;`
	`destructor Destroy; override;`
	`function SendRequest: Boolean;`
	`function SendTrap: Boolean;`
	`function RecvTrap: Boolean;`
	`function DoIt: Boolean;`

Properties

+ + + + + + + + + + + + + + + + + + + + + +

	`property Buffer: AnsiString read FBuffer write FBuffer;`
	`property HostIP: AnsiString read FHostIP;`
	`property Query: TSNMPRec read FQuery;`
	`property Reply: TSNMPRec read FReply;`
	`property Sock: TUDPBlockSocket read FSock;`

Description

Methods

+ + + + + +

constructor Create;

+ + + + + +

destructor Destroy; override;

+ + + + + +

function SendRequest: Boolean;

+Connects to a Host and send there query. If in timeout SNMP server send back query, result is True. If is used SNMPv3, then it synchronize self with SNMPv3 agent first. (It is needed for SNMPv3 auhorization!)

+ + + + + +

function SendTrap: Boolean;

+Send SNMP packet only, but not waits for reply. Good for sending traps.

+ + + + + +

function RecvTrap: Boolean;

+Receive SNMP packet only. Good for receiving traps.

+ + + + + +

function DoIt: Boolean;

+Mapped to SendRequest internally. This function is only for backward compatibility.

Properties

+ + + + + +

property Buffer: AnsiString read FBuffer write FBuffer;

+contains raw binary form of SNMP packet. Good for debugging.

+ + + + + +

property HostIP: AnsiString read FHostIP;

+After SNMP operation hold IP address of remote side.

+ + + + + +

property Query: TSNMPRec read FQuery;

+Data object contains SNMP query.

+ + + + + +

property Reply: TSNMPRec read FReply;

+Data object contains SNMP reply.

+ + + + + +

property Sock: TUDPBlockSocket read FSock;

+Socket object used for TCP/IP operation. Good for seting OnStatus hook, etc.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/snmpsend.TV3Sync.html Index: lib/synapse/docs/help/snmpsend.TV3Sync.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/snmpsend.TV3Sync.html @@ -0,0 +1,65 @@ + + + + + +snmpsend: record TV3Sync + + + +

record TV3Sync

+ + +

Hierarchy

Methods

Properties

Unit

Declaration

+type TV3Sync = record

Description

+It holding all information for SNMPv3 agent synchronization

+ Used internally.

Overview

Fields

+ + + + + + + + + + + + + +

EngineID: AnsiString;

EngineBoots: integer;

EngineTime: integer;

EngineStamp: Cardinal;

Description

Fields

+ + + + +

EngineID: AnsiString;

+ + + + +

EngineBoots: integer;

+ + + + +

EngineTime: integer;

+ + + + +

EngineStamp: Cardinal;

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/snmpsend.html Index: lib/synapse/docs/help/snmpsend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/snmpsend.html @@ -0,0 +1,453 @@ + + + + + +snmpsend + + + +

Unit snmpsend

+ + +

Variables

Description

+SNMP client

+ Supports SNMPv1 include traps, SNMPv2c and SNMPv3 include authorization and privacy encryption. + +

Used RFC: RFC-1157, RFC-1901, RFC-3412, RFC-3414, RFC-3416, RFC-3826 + +

Supported Authorization hashes: MD5, SHA1 Supported Privacy encryptions: DES, 3DES, AES

uses

Overview

Classes, Interfaces, Objects and Records

+ + + + + + + + + + + + + + + + + + + + + +

Name	Description
Class `TSNMPMib`	Data object with one record of MIB OID and corresponding values.
record `TV3Sync`	It holding all information for SNMPv3 agent synchronization
Class `TSNMPRec`	Data object abstracts SNMP data packet
Class `TSNMPSend`	Implementation of SNMP protocol.

Functions and Procedures

+ + + + + + + + + + + + + + + + + + + + + + +

function SNMPGet(const OID, Community, SNMPHost: AnsiString; var Value: AnsiString): Boolean;

function SNMPSet(const OID, Community, SNMPHost, Value: AnsiString; ValueType: Integer): Boolean;

function SNMPGetNext(var OID: AnsiString; const Community, SNMPHost: AnsiString; var Value: AnsiString): Boolean;

function SNMPGetTable(const BaseOID, Community, SNMPHost: AnsiString; const Value: TStrings): Boolean;

function SNMPGetTableElement(const BaseOID, RowID, ColID, Community, SNMPHost: AnsiString; var Value: AnsiString): Boolean;

function SendTrap(const Dest, Source, Enterprise, Community: AnsiString; Generic, Specific, Seconds: Integer; const MIBName, MIBValue: AnsiString; MIBtype: Integer): Integer;

function RecvTrap(var Dest, Source, Enterprise, Community: AnsiString; var Generic, Specific, Seconds: Integer; const MIBName, MIBValue: TStringList): Integer;

Types

+ + + + + + + + + + +

TV3Flags = (...);

TV3Auth = (...);

TV3Priv = (...);

Constants

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

cSnmpProtocol = '161';

cSnmpTrapProtocol = '162';

SNMP_V1 = 0;

SNMP_V2C = 1;

SNMP_V3 = 3;

PDUGetRequest = $A0;

PDUGetNextRequest = $A1;

PDUGetResponse = $A2;

PDUSetRequest = $A3;

PDUTrap = $A4;

PDUGetBulkRequest = $A5;

PDUInformRequest = $A6;

PDUTrapV2 = $A7;

PDUReport = $A8;

ENoError = 0;

ETooBig = 1;

ENoSuchName = 2;

EBadValue = 3;

EReadOnly = 4;

EGenErr = 5;

ENoAccess = 6;

EWrongType = 7;

EWrongLength = 8;

EWrongEncoding = 9;

EWrongValue = 10;

ENoCreation = 11;

EInconsistentValue = 12;

EResourceUnavailable = 13;

ECommitFailed = 14;

EUndoFailed = 15;

EAuthorizationError = 16;

ENotWritable = 17;

EInconsistentName = 18;

Description

Functions and Procedures

+ + + + +

function SNMPGet(const OID, Community, SNMPHost: AnsiString; var Value: AnsiString): Boolean;

+A very useful function and example of its use would be found in the TSNMPSend object. It implements basic GET method of the SNMP protocol. The MIB value is located in the "OID" variable, and is sent to the requested "SNMPHost" with the proper "Community" access identifier. Upon a successful retrieval, "Value" will contain the information requested. If the SNMP operation is successful, the result returns True.

+ + + + +

function SNMPSet(const OID, Community, SNMPHost, Value: AnsiString; ValueType: Integer): Boolean;

+This is useful function and example of use TSNMPSend object. It implements the basic SET method of the SNMP protocol. If the SNMP operation is successful, the result is True. "Value" is value of MIB Oid for "SNMPHost" with "Community" access identifier. You must specify "ValueType" too.

+ + + + +

function SNMPGetNext(var OID: AnsiString; const Community, SNMPHost: AnsiString; var Value: AnsiString): Boolean;

+A very useful function and example of its use would be found in the TSNMPSend object. It implements basic GETNEXT method of the SNMP protocol. The MIB value is located in the "OID" variable, and is sent to the requested "SNMPHost" with the proper "Community" access identifier. Upon a successful retrieval, "Value" will contain the information requested. If the SNMP operation is successful, the result returns True.

+ + + + +

function SNMPGetTable(const BaseOID, Community, SNMPHost: AnsiString; const Value: TStrings): Boolean;

+A very useful function and example of its use would be found in the TSNMPSend object. It implements basic read of SNMP MIB tables. As BaseOID you must specify basic MIB OID of requested table (base IOD is OID without row and column specificator!) Table is readed into stringlist, where each string is comma delimited string. + +

+ + + + +

function SNMPGetTableElement(const BaseOID, RowID, ColID, Community, SNMPHost: AnsiString; var Value: AnsiString): Boolean;

+A very useful function and example of its use would be found in the TSNMPSend object. It implements basic read of SNMP MIB table element. As BaseOID you must specify basic MIB OID of requested table (base IOD is OID without row and column specificator!) As next you must specify identificator of row and column for specify of needed field of table.

+ + + + +

function SendTrap(const Dest, Source, Enterprise, Community: AnsiString; Generic, Specific, Seconds: Integer; const MIBName, MIBValue: AnsiString; MIBtype: Integer): Integer;

+A very useful function and example of its use would be found in the TSNMPSend object. It implements a TRAPv1 to send with all data in the parameters.

+ + + + +

function RecvTrap(var Dest, Source, Enterprise, Community: AnsiString; var Generic, Specific, Seconds: Integer; const MIBName, MIBValue: TStringList): Integer;

+A very useful function and example of its use would be found in the TSNMPSend object. It receives a TRAPv1 and returns all the data that comes with it.

Types

+ + + + +

TV3Flags = (...);

+Possible values for SNMPv3 flags.

+ This flags specify level of authorization and encryption.

+NoAuthNoPriv:
+AuthNoPriv:
+AuthPriv:

+ + + + +

TV3Auth = (...);

+Type of SNMPv3 authorization

+AuthMD5:
+AuthSHA1:

+ + + + +

TV3Priv = (...);

+Type of SNMPv3 privacy

+PrivDES:
+Priv3DES:
+PrivAES:

Constants

+ + + + +

cSnmpProtocol = '161';

+ + + + +

cSnmpTrapProtocol = '162';

+ + + + +

SNMP_V1 = 0;

+ + + + +

SNMP_V2C = 1;

+ + + + +

SNMP_V3 = 3;

+ + + + +

PDUGetRequest = $A0;

+ + + + +

PDUGetNextRequest = $A1;

+ + + + +

PDUGetResponse = $A2;

+ + + + +

PDUSetRequest = $A3;

+ + + + +

PDUTrap = $A4;

+ + + + +

PDUGetBulkRequest = $A5;

+ + + + +

PDUInformRequest = $A6;

+ + + + +

PDUTrapV2 = $A7;

+ + + + +

PDUReport = $A8;

+ + + + +

ENoError = 0;

+ + + + +

ETooBig = 1;

+ + + + +

ENoSuchName = 2;

+ + + + +

EBadValue = 3;

+ + + + +

EReadOnly = 4;

+ + + + +

EGenErr = 5;

+ + + + +

ENoAccess = 6;

+ + + + +

EWrongType = 7;

+ + + + +

EWrongLength = 8;

+ + + + +

EWrongEncoding = 9;

+ + + + +

EWrongValue = 10;

+ + + + +

ENoCreation = 11;

+ + + + +

EInconsistentValue = 12;

+ + + + +

EResourceUnavailable = 13;

+ + + + +

ECommitFailed = 14;

+ + + + +

EUndoFailed = 15;

+ + + + +

EAuthorizationError = 16;

+ + + + +

ENotWritable = 17;

+ + + + +

EInconsistentName = 18;

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/sntpsend.TNtp.html Index: lib/synapse/docs/help/sntpsend.TNtp.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/sntpsend.TNtp.html @@ -0,0 +1,151 @@ + + + + + +sntpsend: packed record TNtp + + + +

packed record TNtp

+ + +

Hierarchy

Methods

Properties

Unit

+sntpsend

Declaration

+type TNtp = packed record

Description

+Record containing the NTP packet.

Overview

Fields

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

mode: Byte;

stratum: Byte;

poll: Byte;

Precision: Byte;

RootDelay: Longint;

RootDisperson: Longint;

RefID: Longint;

Ref1: Longint;

Ref2: Longint;

Org1: Longint;

Org2: Longint;

Rcv1: Longint;

Rcv2: Longint;

Xmit1: Longint;

Xmit2: Longint;

Description

Fields

+ + + + +

mode: Byte;

+ + + + +

stratum: Byte;

+ + + + +

poll: Byte;

+ + + + +

Precision: Byte;

+ + + + +

RootDelay: Longint;

+ + + + +

RootDisperson: Longint;

+ + + + +

RefID: Longint;

+ + + + +

Ref1: Longint;

+ + + + +

Ref2: Longint;

+ + + + +

Org1: Longint;

+ + + + +

Org2: Longint;

+ + + + +

Rcv1: Longint;

+ + + + +

Rcv2: Longint;

+ + + + +

Xmit1: Longint;

+ + + + +

Xmit2: Longint;

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/sntpsend.TSNTPSend.html Index: lib/synapse/docs/help/sntpsend.TSNTPSend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/sntpsend.TSNTPSend.html @@ -0,0 +1,206 @@ + + + + + +sntpsend: Class TSNTPSend + + + +

Class TSNTPSend

+ + +

Fields

Unit

+sntpsend

Declaration

+type TSNTPSend = class(TSynaClient)

Description

+Implementation of NTP and SNTP client protocol

+, include time synchronisation. It can send NTP or SNTP time queries, or it can receive NTP broadcasts too. + +

Note: Are you missing properties for specify server address and port? Look to parent TSynaClient too!

Hierarchy

TObject
TSynaClient
TSNTPSend

Overview

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`constructor Create;`
	`destructor Destroy; override;`
	`function DecodeTs(Nsec, Nfrac: Longint): TDateTime;`
	`procedure EncodeTs(dt: TDateTime; var Nsec, Nfrac: Longint);`
	`function GetSNTP: Boolean;`
	`function GetNTP: Boolean;`
	`function GetBroadcastNTP: Boolean;`

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`property NTPReply: TNtp read FNTPReply;`
	`property NTPTime: TDateTime read FNTPTime;`
	`property NTPOffset: Double read FNTPOffset;`
	`property NTPDelay: Double read FNTPDelay;`
	`property MaxSyncDiff: double read FMaxSyncDiff write FMaxSyncDiff;`
	`property SyncTime: Boolean read FSyncTime write FSyncTime;`
	`property Sock: TUDPBlockSocket read FSock;`

Description

Methods

+ + + + + +

constructor Create;

+ + + + + +

destructor Destroy; override;

+ + + + + +

function DecodeTs(Nsec, Nfrac: Longint): TDateTime;

+Decode 128 bit timestamp used in NTP packet to TDateTime type.

+ + + + + +

procedure EncodeTs(dt: TDateTime; var Nsec, Nfrac: Longint);

+Decode TDateTime type to 128 bit timestamp used in NTP packet.

+ + + + + +

function GetSNTP: Boolean;

+Send request to TSynaClient.TargetHost and wait for reply. If all is OK, then result is True and NTPReply and NTPTime are valid.

+ + + + + +

function GetNTP: Boolean;

+Send request to TSynaClient.TargetHost and wait for reply. If all is OK, then result is True and NTPReply and NTPTime are valid. Result time is after all needed corrections.

+ + + + + +

function GetBroadcastNTP: Boolean;

+Wait for broadcast NTP packet. If all OK, result is True and NTPReply and NTPTime are valid.

Properties

+ + + + + +

property NTPReply: TNtp read FNTPReply;

+Holds last received NTP packet.

+ + + + + +

property NTPTime: TDateTime read FNTPTime;

+Date and time of remote NTP or SNTP server. (UTC time!!!)

+ + + + + +

property NTPOffset: Double read FNTPOffset;

+Offset between your computer and remote NTP or SNTP server.

+ + + + + +

property NTPDelay: Double read FNTPDelay;

+Delay between your computer and remote NTP or SNTP server.

+ + + + + +

property MaxSyncDiff: double read FMaxSyncDiff write FMaxSyncDiff;

+Define allowed maximum difference between your time and remote time for synchronising time. If difference is bigger, your system time is not changed!

+ + + + + +

property SyncTime: Boolean read FSyncTime write FSyncTime;

+If True, after successfull getting time is local computer clock synchronised to given time. For synchronising time you must have proper rights! (Usually Administrator)

+ + + + + +

property Sock: TUDPBlockSocket read FSock;

+Socket object used for TCP/IP operation. Good for seting OnStatus hook, etc.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/sntpsend.html Index: lib/synapse/docs/help/sntpsend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/sntpsend.html @@ -0,0 +1,53 @@ + + + + + +sntpsend + + + +

Unit sntpsend

+ + +

Functions and Procedures

Types

Variables

Description

+ NTP and SNTP client

+ + +

Used RFC: RFC-1305, RFC-2030

uses

SysUtils
synsock
blcksock
synautil

Overview

Classes, Interfaces, Objects and Records

+ + + + + + + + + + + + + +

Name	Description
packed record `TNtp`	Record containing the NTP packet.
Class `TSNTPSend`	Implementation of NTP and SNTP client protocol

Constants

+ + + + +

cNtpProtocol = '123';

Description

Constants

+ + + + +

cNtpProtocol = '123';

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/ssl_cryptlib.TSSLCryptLib.html Index: lib/synapse/docs/help/ssl_cryptlib.TSSLCryptLib.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/ssl_cryptlib.TSSLCryptLib.html @@ -0,0 +1,278 @@ + + + + + +ssl_cryptlib: Class TSSLCryptLib + + + +

Class TSSLCryptLib

+ + +

Fields

Unit

+ssl_cryptlib

Declaration

+type TSSLCryptLib = class(TCustomSSL)

Description

+class implementing CryptLib SSL/SSH plugin.

+ Instance of this class will be created for each TTCPBlockSocket. You not need to create instance of this class, all is done by Synapse itself!

Hierarchy

TObject
TCustomSSL
TSSLCryptLib

Overview

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`constructor Create(const Value: TTCPBlockSocket); override;`
	`destructor Destroy; override;`
	`procedure SetCertCAFile(const Value: string); override;`
	`function LibVersion: String; override;`
	`function LibName: String; override;`
	`procedure Assign(const Value: TCustomSSL); override;`
	`function Connect: boolean; override;`
	`function Accept: boolean; override;`
	`function Shutdown: boolean; override;`
	`function BiShutdown: boolean; override;`
	`function SendBuffer(Buffer: TMemory; Len: Integer): Integer; override;`
	`function RecvBuffer(Buffer: TMemory; Len: Integer): Integer; override;`
	`function WaitingData: Integer; override;`
	`function GetSSLVersion: string; override;`
	`function GetPeerSubject: string; override;`
	`function GetPeerIssuer: string; override;`
	`function GetPeerName: string; override;`
	`function GetPeerFingerprint: string; override;`
	`function GetVerifyCert: integer; override;`

Properties

+ + + + + +

property PrivateKeyLabel: string read FPrivateKeyLabel Write FPrivateKeyLabel;

Description

Methods

+ + + + + +

constructor Create(const Value: TTCPBlockSocket); override;

+See TCustomSSL.Create

+ + + + + +

destructor Destroy; override;

+ + + + + +

procedure SetCertCAFile(const Value: string); override;

+Load trusted CA's in PEM format

+ + + + + +

function LibVersion: String; override;

+ + + + + +

function LibName: String; override;

+ + + + + +

procedure Assign(const Value: TCustomSSL); override;

+See TCustomSSL.Assign

+ + + + + +

function Connect: boolean; override;

+See TCustomSSL.Connect and ssl_cryptlib for more details.

+ + + + + +

function Accept: boolean; override;

+See TCustomSSL.Accept and ssl_cryptlib for more details.

+ + + + + +

function Shutdown: boolean; override;

+ + + + + +

function BiShutdown: boolean; override;

+ + + + + +

function SendBuffer(Buffer: TMemory; Len: Integer): Integer; override;

+ + + + + +

function RecvBuffer(Buffer: TMemory; Len: Integer): Integer; override;

+ + + + + +

function WaitingData: Integer; override;

+ + + + + +

function GetSSLVersion: string; override;

+ + + + + +

function GetPeerSubject: string; override;

+ + + + + +

function GetPeerIssuer: string; override;

+ + + + + +

function GetPeerName: string; override;

+ + + + + +

function GetPeerFingerprint: string; override;

+ + + + + +

function GetVerifyCert: integer; override;

+See TCustomSSL.GetVerifyCert

Properties

+ + + + + +

property PrivateKeyLabel: string read FPrivateKeyLabel Write FPrivateKeyLabel;

+name of certificate/key within PKCS#15 file. It can hold more then one certificate/key and each certificate/key must have unique label within one file.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/ssl_cryptlib.html Index: lib/synapse/docs/help/ssl_cryptlib.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/ssl_cryptlib.html @@ -0,0 +1,46 @@ + + + + + +ssl_cryptlib + + + +

Unit ssl_cryptlib

+ + +

Functions and Procedures

Types

Constants

Variables

Description

+SSL/SSH plugin for CryptLib

+ + +

This plugin requires cl32.dll at least version 3.2.0! It can be used on Win32 and Linux. This library is staticly linked - when you compile your application with this plugin, you MUST distribute it with Cryptib library, otherwise you cannot run your application! + +

It can work with keys and certificates stored as PKCS#15 only! It must be stored as disk file only, you cannot load them from memory! Each file can hold multiple keys and certificates. You must identify it by 'label' stored in TSSLCryptLib.PrivateKeyLabel. + +

If you need to use secure connection and authorize self by certificate (each SSL/TLS server or client with client authorization), then use TCustomSSL.PrivateKeyFile, TSSLCryptLib.PrivateKeyLabel and TCustomSSL.KeyPassword properties. + +

If you need to use server what verifying client certificates, then use TCustomSSL.CertCAFile as PKCS#15 file with public keyas of allowed clients. Clients with non-matching certificates will be rejected by cryptLib. + +

uses

Windows
SysUtils
blcksock
synsock
synautil
synacode
cryptlib

Overview

Classes, Interfaces, Objects and Records

+ + + + + + + + + +

Name	Description
Class `TSSLCryptLib`	class implementing CryptLib SSL/SSH plugin.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/ssl_openssl.TSSLOpenSSL.html Index: lib/synapse/docs/help/ssl_openssl.TSSLOpenSSL.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/ssl_openssl.TSSLOpenSSL.html @@ -0,0 +1,310 @@ + + + + + +ssl_openssl: Class TSSLOpenSSL + + + +

Class TSSLOpenSSL

+ + +

Fields

Properties

Unit

+ssl_openssl

Declaration

+type TSSLOpenSSL = class(TCustomSSL)

Description

+class implementing OpenSSL SSL plugin.

+ Instance of this class will be created for each TTCPBlockSocket. You not need to create instance of this class, all is done by Synapse itself!

Hierarchy

TObject
TCustomSSL
TSSLOpenSSL

Overview

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`constructor Create(const Value: TTCPBlockSocket); override;`
	`destructor Destroy; override;`
	`function LibVersion: String; override;`
	`function LibName: String; override;`
	`function Connect: boolean; override;`
	`function Accept: boolean; override;`
	`function Shutdown: boolean; override;`
	`function BiShutdown: boolean; override;`
	`function SendBuffer(Buffer: TMemory; Len: Integer): Integer; override;`
	`function RecvBuffer(Buffer: TMemory; Len: Integer): Integer; override;`
	`function WaitingData: Integer; override;`
	`function GetSSLVersion: string; override;`
	`function GetPeerSubject: string; override;`
	`function GetPeerSerialNo: integer; override;`
	`function GetPeerIssuer: string; override;`
	`function GetPeerName: string; override;`
	`function GetPeerNameHash: cardinal; override;`
	`function GetPeerFingerprint: string; override;`
	`function GetCertInfo: string; override;`
	`function GetCipherName: string; override;`
	`function GetCipherBits: integer; override;`
	`function GetCipherAlgBits: integer; override;`
	`function GetVerifyCert: integer; override;`

Description

Methods

+ + + + + +

constructor Create(const Value: TTCPBlockSocket); override;

+See TCustomSSL.Create

+ + + + + +

destructor Destroy; override;

+ + + + + +

function LibVersion: String; override;

+ + + + + +

function LibName: String; override;

+ + + + + +

function Connect: boolean; override;

+See TCustomSSL.Connect and ssl_cryptlib for more details.

+ + + + + +

function Accept: boolean; override;

+See TCustomSSL.Accept and ssl_cryptlib for more details.

+ + + + + +

function Shutdown: boolean; override;

+ + + + + +

function BiShutdown: boolean; override;

+ + + + + +

function SendBuffer(Buffer: TMemory; Len: Integer): Integer; override;

+ + + + + +

function RecvBuffer(Buffer: TMemory; Len: Integer): Integer; override;

+ + + + + +

function WaitingData: Integer; override;

+ + + + + +

function GetSSLVersion: string; override;

+ + + + + +

function GetPeerSubject: string; override;

+ + + + + +

function GetPeerSerialNo: integer; override;

+See TCustomSSL.GetPeerSerialNo

+ + + + + +

function GetPeerIssuer: string; override;

+ + + + + +

function GetPeerName: string; override;

+ + + + + +

function GetPeerNameHash: cardinal; override;

+See TCustomSSL.GetPeerNameHash

+ + + + + +

function GetPeerFingerprint: string; override;

+ + + + + +

function GetCertInfo: string; override;

+See TCustomSSL.GetCertInfo

+ + + + + +

function GetCipherName: string; override;

+See TCustomSSL.GetCipherName

+ + + + + +

function GetCipherBits: integer; override;

+See TCustomSSL.GetCipherBits

+ + + + + +

function GetCipherAlgBits: integer; override;

+See TCustomSSL.GetCipherAlgBits

+ + + + + +

function GetVerifyCert: integer; override;

+See TCustomSSL.GetVerifyCert

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:52 + + ADDED lib/synapse/docs/help/ssl_openssl.html Index: lib/synapse/docs/help/ssl_openssl.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/ssl_openssl.html @@ -0,0 +1,46 @@ + + + + + +ssl_openssl + + + +

Unit ssl_openssl

+ + +

Functions and Procedures

Types

Constants

Variables

Description

+SSL plugin for OpenSSL

+ + +

You need OpenSSL libraries version 0.9.7. It can work with 0.9.6 too, but application mysteriously crashing when you are using freePascal on Linux. Use Kylix on Linux is OK! If you have version 0.9.7 on Linux, then I not see any problems with FreePascal. + +

OpenSSL libraries are loaded dynamicly - you not need OpenSSl librares even you compile your application with this unit. SSL just not working when you not have OpenSSL libraries. + +

This plugin have limited support for .NET too! Because is not possible to use callbacks with CDECL calling convention under .NET, is not supported key/certificate passwords and multithread locking. :-( + +

For handling keys and certificates you can use this properties: + +

TCustomSSL.CertificateFile for PEM or ASN1 DER (cer) format.
TCustomSSL.Certificate for ASN1 DER format only.
TCustomSSL.PrivateKeyFile for PEM or ASN1 DER (key) format.
TCustomSSL.PrivateKey for ASN1 DER format only.
TCustomSSL.CertCAFile for PEM CA certificate bundle.
TCustomSSL.PFXfile for PFX format.
TCustomSSL.PFX for PFX format from binary string.
+ +

uses

SysUtils
Classes
blcksock
synsock
synautil
ssl_openssl_lib

Overview

Classes, Interfaces, Objects and Records

+ + + + + + + + + +

Name	Description
Class `TSSLOpenSSL`	class implementing OpenSSL SSL plugin.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:51 + + ADDED lib/synapse/docs/help/ssl_openssl_lib.des_ks_struct.html Index: lib/synapse/docs/help/ssl_openssl_lib.des_ks_struct.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/ssl_openssl_lib.des_ks_struct.html @@ -0,0 +1,45 @@ + + + + + +ssl_openssl_lib: packed record des_ks_struct + + + +

packed record des_ks_struct

+ + +

Hierarchy

Methods

Properties

Unit

+ssl_openssl_lib

Declaration

+type des_ks_struct = packed record

Description

Overview

Fields

+ + + + + + + +

ks: DES_cblock;

weak_key: Integer;

Description

Fields

+ + + + +

ks: DES_cblock;

+ + + + +

weak_key: Integer;

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:52 + + ADDED lib/synapse/docs/help/ssl_openssl_lib.html Index: lib/synapse/docs/help/ssl_openssl_lib.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/ssl_openssl_lib.html @@ -0,0 +1,1541 @@ + + + + + +ssl_openssl_lib + + + +

Unit ssl_openssl_lib

+ + +

Description

+OpenSSL support

+ + +

uses

Classes
synafpc
Windows

Overview

Classes, Interfaces, Objects and Records

+ + + + + + + + + +

Name	Description
packed record `des_ks_struct`

Functions and Procedures

function SslGetError(s: PSSL; ret_code: Integer):Integer;

function SslLibraryInit:Integer;

procedure SslLoadErrorStrings;

function SslCtxSetCipherList(arg0: PSSL_CTX; var str: AnsiString):Integer;

function SslCtxNew(meth: PSSL_METHOD):PSSL_CTX;

procedure SslCtxFree(arg0: PSSL_CTX);

function SslSetFd(s: PSSL; fd: Integer):Integer;

function SslMethodV2:PSSL_METHOD;

function SslMethodV3:PSSL_METHOD;

function SslMethodTLSV1:PSSL_METHOD;

function SslMethodV23:PSSL_METHOD;

function SslCtxUsePrivateKey(ctx: PSSL_CTX; pkey: SslPtr):Integer;

function SslCtxUsePrivateKeyASN1(pk: integer; ctx: PSSL_CTX; d: AnsiString; len: integer):Integer;

function SslCtxUsePrivateKeyFile(ctx: PSSL_CTX; const _file: AnsiString; _type: Integer):Integer;

function SslCtxUseCertificate(ctx: PSSL_CTX; x: SslPtr):Integer;

function SslCtxUseCertificateASN1(ctx: PSSL_CTX; len: integer; d: AnsiString):Integer;

function SslCtxUseCertificateFile(ctx: PSSL_CTX; const _file: AnsiString; _type: Integer):Integer;

function SslCtxUseCertificateChainFile(ctx: PSSL_CTX; const _file: AnsiString):Integer;

function SslCtxCheckPrivateKeyFile(ctx: PSSL_CTX):Integer;

procedure SslCtxSetDefaultPasswdCb(ctx: PSSL_CTX; cb: PPasswdCb);

procedure SslCtxSetDefaultPasswdCbUserdata(ctx: PSSL_CTX; u: SslPtr);

function SslCtxLoadVerifyLocations(ctx: PSSL_CTX; const CAfile: AnsiString; const CApath: AnsiString):Integer;

function SslCtxCtrl(ctx: PSSL_CTX; cmd: integer; larg: integer; parg: SslPtr): integer;

function SslNew(ctx: PSSL_CTX):PSSL;

procedure SslFree(ssl: PSSL);

function SslAccept(ssl: PSSL):Integer;

function SslConnect(ssl: PSSL):Integer;

function SslShutdown(ssl: PSSL):Integer;

function SslRead(ssl: PSSL; buf: SslPtr; num: Integer):Integer;

function SslPeek(ssl: PSSL; buf: SslPtr; num: Integer):Integer;

function SslWrite(ssl: PSSL; buf: SslPtr; num: Integer):Integer;

function SslPending(ssl: PSSL):Integer;

function SslGetVersion(ssl: PSSL):AnsiString;

function SslGetPeerCertificate(ssl: PSSL):PX509;

procedure SslCtxSetVerify(ctx: PSSL_CTX; mode: Integer; arg2: PFunction);

function SSLGetCurrentCipher(s: PSSL):SslPtr;

function SSLCipherGetName(c: SslPtr): AnsiString;

function SSLCipherGetBits(c: SslPtr; var alg_bits: Integer):Integer;

function SSLGetVerifyResult(ssl: PSSL):Integer;

function SSLCtrl(ssl: PSSL; cmd: integer; larg: integer; parg: SslPtr):Integer;

function X509New: PX509;

procedure X509Free(x: PX509);

function X509NameOneline(a: PX509_NAME; var buf: AnsiString; size: Integer):AnsiString;

function X509GetSubjectName(a: PX509):PX509_NAME;

function X509GetIssuerName(a: PX509):PX509_NAME;

function X509NameHash(x: PX509_NAME):Cardinal;

function X509Digest(data: PX509; _type: PEVP_MD; md: AnsiString; var len: Integer):Integer;

function X509print(b: PBIO; a: PX509): integer;

function X509SetVersion(x: PX509; version: integer): integer;

function X509SetPubkey(x: PX509; pkey: EVP_PKEY): integer;

function X509SetIssuerName(x: PX509; name: PX509_NAME): integer;

function X509NameAddEntryByTxt(name: PX509_NAME; field: Ansistring; _type: integer; bytes: Ansistring; len, loc, _set: integer): integer;

function X509Sign(x: PX509; pkey: EVP_PKEY; const md: PEVP_MD): integer;

function X509GmtimeAdj(s: PASN1_UTCTIME; adj: integer): PASN1_UTCTIME;

function X509SetNotBefore(x: PX509; tm: PASN1_UTCTIME): integer;

function X509SetNotAfter(x: PX509; tm: PASN1_UTCTIME): integer;

function X509GetSerialNumber(x: PX509): PASN1_INTEGER;

function EvpPkeyNew: EVP_PKEY;

procedure EvpPkeyFree(pk: EVP_PKEY);

function EvpPkeyAssign(pkey: EVP_PKEY; _type: integer; key: Prsa): integer;

function EvpGetDigestByName(Name: AnsiString): PEVP_MD;

procedure EVPcleanup;

function SSLeayversion(t: integer): Ansistring;

procedure ErrErrorString(e: integer; var buf: Ansistring; len: integer);

function ErrGetError: integer;

procedure ErrClearError;

procedure ErrFreeStrings;

procedure ErrRemoveState(pid: integer);

procedure OPENSSLaddallalgorithms;

procedure CRYPTOcleanupAllExData;

procedure RandScreen;

function BioNew(b: PBIO_METHOD): PBIO;

procedure BioFreeAll(b: PBIO);

function BioSMem: PBIO_METHOD;

function BioCtrlPending(b: PBIO): integer;

function BioRead(b: PBIO; var Buf: AnsiString; Len: integer): integer;

function BioWrite(b: PBIO; Buf: AnsiString; Len: integer): integer;

function d2iPKCS12bio(b:PBIO; Pkcs12: SslPtr): SslPtr;

function PKCS12parse(p12: SslPtr; pass: Ansistring; var pkey, cert, ca: SslPtr): integer;

procedure PKCS12free(p12: SslPtr);

function RsaGenerateKey(bits, e: integer; callback: PFunction; cb_arg: SslPtr): PRSA;

function Asn1UtctimeNew: PASN1_UTCTIME;

procedure Asn1UtctimeFree(a: PASN1_UTCTIME);

function Asn1IntegerSet(a: PASN1_INTEGER; v: integer): integer;

function Asn1IntegerGet(a: PASN1_INTEGER): integer;

function i2dX509bio(b: PBIO; x: PX509): integer;

function d2iX509bio(b:PBIO; x:PX509): PX509;

function PEMReadBioX509(b:PBIO; x:PSslPtr; callback:PFunction; cb_arg: SslPtr): PX509;

procedure SkX509PopFree(st: PSTACK; func: TSkPopFreeFunc);

function i2dPrivateKeyBio(b: PBIO; pkey: EVP_PKEY): integer;

procedure DESsetoddparity(Key: des_cblock);

function DESsetkeychecked(key: des_cblock; schedule: des_key_schedule): Integer;

procedure DESecbencrypt(Input: des_cblock; output: des_cblock; ks: des_key_schedule; enc: Integer);

function IsSSLloaded: Boolean;

function InitSSLInterface: Boolean;

function DestroySSLInterface: Boolean;

Types

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

SslPtr = Pointer;

PSslPtr = ˆSslPtr;

PSSL_CTX = SslPtr;

PSSL = SslPtr;

PSSL_METHOD = SslPtr;

PX509 = SslPtr;

PX509_NAME = SslPtr;

PEVP_MD = SslPtr;

PInteger = ˆInteger;

PBIO_METHOD = SslPtr;

PBIO = SslPtr;

EVP_PKEY = SslPtr;

PRSA = SslPtr;

PASN1_UTCTIME = SslPtr;

PASN1_INTEGER = SslPtr;

PPasswdCb = SslPtr;

PFunction = procedure;

PSTACK = SslPtr;

TSkPopFreeFunc = procedure(p:SslPtr); cdecl;

TX509Free = procedure(x: PX509); cdecl;

DES_cblock = array[0..7] of Byte;

PDES_cblock = ˆDES_cblock;

des_key_schedule = array[1..16] of des_ks_struct;

Constants

EVP_MAX_MD_SIZE = 16 + 20;

SSL_ERROR_NONE = 0;

SSL_ERROR_SSL = 1;

SSL_ERROR_WANT_READ = 2;

SSL_ERROR_WANT_WRITE = 3;

SSL_ERROR_WANT_X509_LOOKUP = 4;

SSL_ERROR_SYSCALL = 5;

SSL_ERROR_ZERO_RETURN = 6;

SSL_ERROR_WANT_CONNECT = 7;

SSL_ERROR_WANT_ACCEPT = 8;

SSL_OP_NO_SSLv2 = $01000000;

SSL_OP_NO_SSLv3 = $02000000;

SSL_OP_NO_TLSv1 = $04000000;

SSL_OP_ALL = $000FFFFF;

SSL_VERIFY_NONE = $00;

SSL_VERIFY_PEER = $01;

OPENSSL_DES_DECRYPT = 0;

OPENSSL_DES_ENCRYPT = 1;

X509_V_OK = 0;

X509_V_ILLEGAL = 1;

X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT = 2;

X509_V_ERR_UNABLE_TO_GET_CRL = 3;

X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE = 4;

X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE = 5;

X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY = 6;

X509_V_ERR_CERT_SIGNATURE_FAILURE = 7;

X509_V_ERR_CRL_SIGNATURE_FAILURE = 8;

X509_V_ERR_CERT_NOT_YET_VALID = 9;

X509_V_ERR_CERT_HAS_EXPIRED = 10;

X509_V_ERR_CRL_NOT_YET_VALID = 11;

X509_V_ERR_CRL_HAS_EXPIRED = 12;

X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD = 13;

X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD = 14;

X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD = 15;

X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD = 16;

X509_V_ERR_OUT_OF_MEM = 17;

X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT = 18;

X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN = 19;

X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY = 20;

X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE = 21;

X509_V_ERR_CERT_CHAIN_TOO_LONG = 22;

X509_V_ERR_CERT_REVOKED = 23;

X509_V_ERR_INVALID_CA = 24;

X509_V_ERR_PATH_LENGTH_EXCEEDED = 25;

X509_V_ERR_INVALID_PURPOSE = 26;

X509_V_ERR_CERT_UNTRUSTED = 27;

X509_V_ERR_CERT_REJECTED = 28;

X509_V_ERR_SUBJECT_ISSUER_MISMATCH = 29;

X509_V_ERR_AKID_SKID_MISMATCH = 30;

X509_V_ERR_AKID_ISSUER_SERIAL_MISMATCH = 31;

X509_V_ERR_KEYUSAGE_NO_CERTSIGN = 32;

X509_V_ERR_UNABLE_TO_GET_CRL_ISSUER = 33;

X509_V_ERR_UNHANDLED_CRITICAL_EXTENSION = 34;

X509_V_ERR_APPLICATION_VERIFICATION = 50;

SSL_FILETYPE_ASN1 = 2;

SSL_FILETYPE_PEM = 1;

EVP_PKEY_RSA = 6;

SSL_CTRL_SET_TLSEXT_HOSTNAME = 55;

TLSEXT_NAMETYPE_host_name = 0;

Variables

+ + + + + + + + + + + + + + + + + + + + + + + + + +

DLLSSLName: string = 'ssleay32.dll';

DLLSSLName2: string = 'libssl32.dll';

DLLUtilName: string = 'libeay32.dll';

SSLLibHandle: TLibHandle = 0;

SSLUtilHandle: TLibHandle = 0;

SSLLibFile: string = '';

SSLUtilFile: string = '';

_X509Free: TX509Free = nil;

Description

Functions and Procedures

+ + + + +

function SslGetError(s: PSSL; ret_code: Integer):Integer;

+ + + + +

function SslLibraryInit:Integer;

+ + + + +

procedure SslLoadErrorStrings;

+ + + + +

function SslCtxSetCipherList(arg0: PSSL_CTX; var str: AnsiString):Integer;

+ + + + +

function SslCtxNew(meth: PSSL_METHOD):PSSL_CTX;

+ + + + +

procedure SslCtxFree(arg0: PSSL_CTX);

+ + + + +

function SslSetFd(s: PSSL; fd: Integer):Integer;

+ + + + +

function SslMethodV2:PSSL_METHOD;

+ + + + +

function SslMethodV3:PSSL_METHOD;

+ + + + +

function SslMethodTLSV1:PSSL_METHOD;

+ + + + +

function SslMethodV23:PSSL_METHOD;

+ + + + +

function SslCtxUsePrivateKey(ctx: PSSL_CTX; pkey: SslPtr):Integer;

+ + + + +

function SslCtxUsePrivateKeyASN1(pk: integer; ctx: PSSL_CTX; d: AnsiString; len: integer):Integer;

+ + + + +

function SslCtxUsePrivateKeyFile(ctx: PSSL_CTX; const _file: AnsiString; _type: Integer):Integer;

+ + + + +

function SslCtxUseCertificate(ctx: PSSL_CTX; x: SslPtr):Integer;

+ + + + +

function SslCtxUseCertificateASN1(ctx: PSSL_CTX; len: integer; d: AnsiString):Integer;

+ + + + +

function SslCtxUseCertificateFile(ctx: PSSL_CTX; const _file: AnsiString; _type: Integer):Integer;

+ + + + +

function SslCtxUseCertificateChainFile(ctx: PSSL_CTX; const _file: AnsiString):Integer;

+ + + + +

function SslCtxCheckPrivateKeyFile(ctx: PSSL_CTX):Integer;

+ + + + +

procedure SslCtxSetDefaultPasswdCb(ctx: PSSL_CTX; cb: PPasswdCb);

+ + + + +

procedure SslCtxSetDefaultPasswdCbUserdata(ctx: PSSL_CTX; u: SslPtr);

+ + + + +

function SslCtxLoadVerifyLocations(ctx: PSSL_CTX; const CAfile: AnsiString; const CApath: AnsiString):Integer;

+ + + + +

function SslCtxCtrl(ctx: PSSL_CTX; cmd: integer; larg: integer; parg: SslPtr): integer;

+ + + + +

function SslNew(ctx: PSSL_CTX):PSSL;

+ + + + +

procedure SslFree(ssl: PSSL);

+ + + + +

function SslAccept(ssl: PSSL):Integer;

+ + + + +

function SslConnect(ssl: PSSL):Integer;

+ + + + +

function SslShutdown(ssl: PSSL):Integer;

+ + + + +

function SslRead(ssl: PSSL; buf: SslPtr; num: Integer):Integer;

+ + + + +

function SslPeek(ssl: PSSL; buf: SslPtr; num: Integer):Integer;

+ + + + +

function SslWrite(ssl: PSSL; buf: SslPtr; num: Integer):Integer;

+ + + + +

function SslPending(ssl: PSSL):Integer;

+ + + + +

function SslGetVersion(ssl: PSSL):AnsiString;

+ + + + +

function SslGetPeerCertificate(ssl: PSSL):PX509;

+ + + + +

procedure SslCtxSetVerify(ctx: PSSL_CTX; mode: Integer; arg2: PFunction);

+ + + + +

function SSLGetCurrentCipher(s: PSSL):SslPtr;

+ + + + +

function SSLCipherGetName(c: SslPtr): AnsiString;

+ + + + +

function SSLCipherGetBits(c: SslPtr; var alg_bits: Integer):Integer;

+ + + + +

function SSLGetVerifyResult(ssl: PSSL):Integer;

+ + + + +

function SSLCtrl(ssl: PSSL; cmd: integer; larg: integer; parg: SslPtr):Integer;

+ + + + +

function X509New: PX509;

+ + + + +

procedure X509Free(x: PX509);

+ + + + +

function X509NameOneline(a: PX509_NAME; var buf: AnsiString; size: Integer):AnsiString;

+ + + + +

function X509GetSubjectName(a: PX509):PX509_NAME;

+ + + + +

function X509GetIssuerName(a: PX509):PX509_NAME;

+ + + + +

function X509NameHash(x: PX509_NAME):Cardinal;

+ + + + +

function X509Digest(data: PX509; _type: PEVP_MD; md: AnsiString; var len: Integer):Integer;

+ + + + +

function X509print(b: PBIO; a: PX509): integer;

+ + + + +

function X509SetVersion(x: PX509; version: integer): integer;

+ + + + +

function X509SetPubkey(x: PX509; pkey: EVP_PKEY): integer;

+ + + + +

function X509SetIssuerName(x: PX509; name: PX509_NAME): integer;

+ + + + +

function X509NameAddEntryByTxt(name: PX509_NAME; field: Ansistring; _type: integer; bytes: Ansistring; len, loc, _set: integer): integer;

+ + + + +

function X509Sign(x: PX509; pkey: EVP_PKEY; const md: PEVP_MD): integer;

+ + + + +

function X509GmtimeAdj(s: PASN1_UTCTIME; adj: integer): PASN1_UTCTIME;

+ + + + +

function X509SetNotBefore(x: PX509; tm: PASN1_UTCTIME): integer;

+ + + + +

function X509SetNotAfter(x: PX509; tm: PASN1_UTCTIME): integer;

+ + + + +

function X509GetSerialNumber(x: PX509): PASN1_INTEGER;

+ + + + +

function EvpPkeyNew: EVP_PKEY;

+ + + + +

procedure EvpPkeyFree(pk: EVP_PKEY);

+ + + + +

function EvpPkeyAssign(pkey: EVP_PKEY; _type: integer; key: Prsa): integer;

+ + + + +

function EvpGetDigestByName(Name: AnsiString): PEVP_MD;

+ + + + +

procedure EVPcleanup;

+ + + + +

function SSLeayversion(t: integer): Ansistring;

+ + + + +

procedure ErrErrorString(e: integer; var buf: Ansistring; len: integer);

+ + + + +

function ErrGetError: integer;

+ + + + +

procedure ErrClearError;

+ + + + +

procedure ErrFreeStrings;

+ + + + +

procedure ErrRemoveState(pid: integer);

+ + + + +

procedure OPENSSLaddallalgorithms;

+ + + + +

procedure CRYPTOcleanupAllExData;

+ + + + +

procedure RandScreen;

+ + + + +

function BioNew(b: PBIO_METHOD): PBIO;

+ + + + +

procedure BioFreeAll(b: PBIO);

+ + + + +

function BioSMem: PBIO_METHOD;

+ + + + +

function BioCtrlPending(b: PBIO): integer;

+ + + + +

function BioRead(b: PBIO; var Buf: AnsiString; Len: integer): integer;

+ + + + +

function BioWrite(b: PBIO; Buf: AnsiString; Len: integer): integer;

+ + + + +

function d2iPKCS12bio(b:PBIO; Pkcs12: SslPtr): SslPtr;

+ + + + +

function PKCS12parse(p12: SslPtr; pass: Ansistring; var pkey, cert, ca: SslPtr): integer;

+ + + + +

procedure PKCS12free(p12: SslPtr);

+ + + + +

function RsaGenerateKey(bits, e: integer; callback: PFunction; cb_arg: SslPtr): PRSA;

+ + + + +

function Asn1UtctimeNew: PASN1_UTCTIME;

+ + + + +

procedure Asn1UtctimeFree(a: PASN1_UTCTIME);

+ + + + +

function Asn1IntegerSet(a: PASN1_INTEGER; v: integer): integer;

+ + + + +

function Asn1IntegerGet(a: PASN1_INTEGER): integer;

+ + + + +

function i2dX509bio(b: PBIO; x: PX509): integer;

+ + + + +

function d2iX509bio(b:PBIO; x:PX509): PX509;

+ + + + +

function PEMReadBioX509(b:PBIO; x:PSslPtr; callback:PFunction; cb_arg: SslPtr): PX509;

+ + + + +

procedure SkX509PopFree(st: PSTACK; func: TSkPopFreeFunc);

+ + + + +

function i2dPrivateKeyBio(b: PBIO; pkey: EVP_PKEY): integer;

+ + + + +

procedure DESsetoddparity(Key: des_cblock);

+ + + + +

function DESsetkeychecked(key: des_cblock; schedule: des_key_schedule): Integer;

+ + + + +

procedure DESecbencrypt(Input: des_cblock; output: des_cblock; ks: des_key_schedule; enc: Integer);

+ + + + +

function IsSSLloaded: Boolean;

+ + + + +

function InitSSLInterface: Boolean;

+ + + + +

function DestroySSLInterface: Boolean;

Types

+ + + + +

SslPtr = Pointer;

+ + + + +

PSslPtr = ˆSslPtr;

+ + + + +

PSSL_CTX = SslPtr;

+ + + + +

PSSL = SslPtr;

+ + + + +

PSSL_METHOD = SslPtr;

+ + + + +

PX509 = SslPtr;

+ + + + +

PX509_NAME = SslPtr;

+ + + + +

PEVP_MD = SslPtr;

+ + + + +

PInteger = ˆInteger;

+ + + + +

PBIO_METHOD = SslPtr;

+ + + + +

PBIO = SslPtr;

+ + + + +

EVP_PKEY = SslPtr;

+ + + + +

PRSA = SslPtr;

+ + + + +

PASN1_UTCTIME = SslPtr;

+ + + + +

PASN1_INTEGER = SslPtr;

+ + + + +

PPasswdCb = SslPtr;

+ + + + +

PFunction = procedure;

+ + + + +

PSTACK = SslPtr;

+ + + + +

TSkPopFreeFunc = procedure(p:SslPtr); cdecl;

+ + + + +

TX509Free = procedure(x: PX509); cdecl;

+ + + + +

DES_cblock = array[0..7] of Byte;

+ + + + +

PDES_cblock = ˆDES_cblock;

+ + + + +

des_key_schedule = array[1..16] of des_ks_struct;

Constants

+ + + + +

EVP_MAX_MD_SIZE = 16 + 20;

+ + + + +

SSL_ERROR_NONE = 0;

+ + + + +

SSL_ERROR_SSL = 1;

+ + + + +

SSL_ERROR_WANT_READ = 2;

+ + + + +

SSL_ERROR_WANT_WRITE = 3;

+ + + + +

SSL_ERROR_WANT_X509_LOOKUP = 4;

+ + + + +

SSL_ERROR_SYSCALL = 5;

+ + + + +

SSL_ERROR_ZERO_RETURN = 6;

+ + + + +

SSL_ERROR_WANT_CONNECT = 7;

+ + + + +

SSL_ERROR_WANT_ACCEPT = 8;

+ + + + +

SSL_OP_NO_SSLv2 = $01000000;

+ + + + +

SSL_OP_NO_SSLv3 = $02000000;

+ + + + +

SSL_OP_NO_TLSv1 = $04000000;

+ + + + +

SSL_OP_ALL = $000FFFFF;

+ + + + +

SSL_VERIFY_NONE = $00;

+ + + + +

SSL_VERIFY_PEER = $01;

+ + + + +

OPENSSL_DES_DECRYPT = 0;

+ + + + +

OPENSSL_DES_ENCRYPT = 1;

+ + + + +

X509_V_OK = 0;

+ + + + +

X509_V_ILLEGAL = 1;

+ + + + +

X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT = 2;

+ + + + +

X509_V_ERR_UNABLE_TO_GET_CRL = 3;

+ + + + +

X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE = 4;

+ + + + +

X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE = 5;

+ + + + +

X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY = 6;

+ + + + +

X509_V_ERR_CERT_SIGNATURE_FAILURE = 7;

+ + + + +

X509_V_ERR_CRL_SIGNATURE_FAILURE = 8;

+ + + + +

X509_V_ERR_CERT_NOT_YET_VALID = 9;

+ + + + +

X509_V_ERR_CERT_HAS_EXPIRED = 10;

+ + + + +

X509_V_ERR_CRL_NOT_YET_VALID = 11;

+ + + + +

X509_V_ERR_CRL_HAS_EXPIRED = 12;

+ + + + +

X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD = 13;

+ + + + +

X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD = 14;

+ + + + +

X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD = 15;

+ + + + +

X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD = 16;

+ + + + +

X509_V_ERR_OUT_OF_MEM = 17;

+ + + + +

X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT = 18;

+ + + + +

X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN = 19;

+ + + + +

X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY = 20;

+ + + + +

X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE = 21;

+ + + + +

X509_V_ERR_CERT_CHAIN_TOO_LONG = 22;

+ + + + +

X509_V_ERR_CERT_REVOKED = 23;

+ + + + +

X509_V_ERR_INVALID_CA = 24;

+ + + + +

X509_V_ERR_PATH_LENGTH_EXCEEDED = 25;

+ + + + +

X509_V_ERR_INVALID_PURPOSE = 26;

+ + + + +

X509_V_ERR_CERT_UNTRUSTED = 27;

+ + + + +

X509_V_ERR_CERT_REJECTED = 28;

+ + + + +

X509_V_ERR_SUBJECT_ISSUER_MISMATCH = 29;

+ + + + +

X509_V_ERR_AKID_SKID_MISMATCH = 30;

+ + + + +

X509_V_ERR_AKID_ISSUER_SERIAL_MISMATCH = 31;

+ + + + +

X509_V_ERR_KEYUSAGE_NO_CERTSIGN = 32;

+ + + + +

X509_V_ERR_UNABLE_TO_GET_CRL_ISSUER = 33;

+ + + + +

X509_V_ERR_UNHANDLED_CRITICAL_EXTENSION = 34;

+ + + + +

X509_V_ERR_APPLICATION_VERIFICATION = 50;

+ + + + +

SSL_FILETYPE_ASN1 = 2;

+ + + + +

SSL_FILETYPE_PEM = 1;

+ + + + +

EVP_PKEY_RSA = 6;

+ + + + +

SSL_CTRL_SET_TLSEXT_HOSTNAME = 55;

+ + + + +

TLSEXT_NAMETYPE_host_name = 0;

Variables

+ + + + +

DLLSSLName: string = 'ssleay32.dll';

+ + + + +

DLLSSLName2: string = 'libssl32.dll';

+ + + + +

DLLUtilName: string = 'libeay32.dll';

+ + + + +

SSLLibHandle: TLibHandle = 0;

+ + + + +

SSLUtilHandle: TLibHandle = 0;

+ + + + +

SSLLibFile: string = '';

+ + + + +

SSLUtilFile: string = '';

+ + + + +

_X509Free: TX509Free = nil;

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:52 + + ADDED lib/synapse/docs/help/ssl_sbb.TSSLSBB.html Index: lib/synapse/docs/help/ssl_sbb.TSSLSBB.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/ssl_sbb.TSSLSBB.html @@ -0,0 +1,280 @@ + + + + + +ssl_sbb: Class TSSLSBB + + + +

Class TSSLSBB

+ + +

Fields

Unit

+ssl_sbb

Declaration

+type TSSLSBB = class(TCustomSSL)

Description

+class implementing SecureBlackbox SSL plugin.

+ Instance of this class will be created for each TTCPBlockSocket. You not need to create instance of this class, all is done by Synapse itself!

Hierarchy

TObject
TCustomSSL
TSSLSBB

Overview

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`constructor Create(const Value: TTCPBlockSocket); override;`
	`destructor Destroy; override;`
	`function LibVersion: String; override;`
	`function LibName: String; override;`
	`function Connect: boolean; override;`
	`function Accept: boolean; override;`
	`function Shutdown: boolean; override;`
	`function BiShutdown: boolean; override;`
	`function SendBuffer(Buffer: TMemory; Len: Integer): Integer; override;`
	`function RecvBuffer(Buffer: TMemory; Len: Integer): Integer; override;`
	`function WaitingData: Integer; override;`
	`function GetSSLVersion: string; override;`
	`function GetPeerSubject: string; override;`
	`function GetPeerIssuer: string; override;`
	`function GetPeerName: string; override;`
	`function GetPeerFingerprint: string; override;`
	`function GetCertInfo: string; override;`

Properties

+ + + + + + + + + + + + + + + + + +

	`property ElSecureClient: TElSecureClient read FElSecureClient write FElSecureClient;`
	`property ElSecureServer: TElSecureServer read FElSecureServer write FElSecureServer;`
	`property CipherSuites: TBits read FCipherSuites write FCipherSuites;`
	`property CipherSuite: Integer read GetCipherSuite;`

Description

Methods

+ + + + + +

constructor Create(const Value: TTCPBlockSocket); override;

+ + + + + +

destructor Destroy; override;

+ + + + + +

function LibVersion: String; override;

+ + + + + +

function LibName: String; override;

+ + + + + +

function Connect: boolean; override;

+See TCustomSSL.Connect and ssl_sbb for more details.

+ + + + + +

function Accept: boolean; override;

+See TCustomSSL.Accept and ssl_sbb for more details.

+ + + + + +

function Shutdown: boolean; override;

+ + + + + +

function BiShutdown: boolean; override;

+ + + + + +

function SendBuffer(Buffer: TMemory; Len: Integer): Integer; override;

+ + + + + +

function RecvBuffer(Buffer: TMemory; Len: Integer): Integer; override;

+ + + + + +

function WaitingData: Integer; override;

+ + + + + +

function GetSSLVersion: string; override;

+ + + + + +

function GetPeerSubject: string; override;

+ + + + + +

function GetPeerIssuer: string; override;

+ + + + + +

function GetPeerName: string; override;

+ + + + + +

function GetPeerFingerprint: string; override;

+ + + + + +

function GetCertInfo: string; override;

+See TCustomSSL.GetCertInfo

Properties

+ + + + + +

property ElSecureClient: TElSecureClient read FElSecureClient write FElSecureClient;

+ + + + + +

property ElSecureServer: TElSecureServer read FElSecureServer write FElSecureServer;

+ + + + + +

property CipherSuites: TBits read FCipherSuites write FCipherSuites;

+ + + + + +

property CipherSuite: Integer read GetCipherSuite;

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:52 + + ADDED lib/synapse/docs/help/ssl_sbb.html Index: lib/synapse/docs/help/ssl_sbb.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/ssl_sbb.html @@ -0,0 +1,49 @@ + + + + + +ssl_sbb + + + +

Unit ssl_sbb

+ + +

Functions and Procedures

Types

Variables

Description

+SSL plugin for Eldos SecureBlackBox

+ + +

uses

SysUtils
Classes
Windows
blcksock
synsock
synautil
synacode
SBClient
SBServer
SBX509
SBWinCertStorage
SBCustomCertStorage
SBUtils
SBConstants
SBSessionPool

Overview

Classes, Interfaces, Objects and Records

+ + + + + + + + + +

Name	Description
Class `TSSLSBB`	class implementing SecureBlackbox SSL plugin.

Constants

+ + + + +

DEFAULT_RECV_BUFFER=32768;

Description

Constants

+ + + + +

DEFAULT_RECV_BUFFER=32768;

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:52 + + ADDED lib/synapse/docs/help/ssl_streamsec.TSSLStreamSec.html Index: lib/synapse/docs/help/ssl_streamsec.TSSLStreamSec.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/ssl_streamsec.TSSLStreamSec.html @@ -0,0 +1,252 @@ + + + + + +ssl_streamsec: Class TSSLStreamSec + + + +

Class TSSLStreamSec

+ + +

Fields

Unit

+ssl_streamsec

Declaration

+type TSSLStreamSec = class(TCustomSSL)

Description

+class implementing StreamSecII SSL plugin.

+ Instance of this class will be created for each TTCPBlockSocket. You not need to create instance of this class, all is done by Synapse itself!

Hierarchy

TObject
TCustomSSL
TSSLStreamSec

Overview

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`constructor Create(const Value: TTCPBlockSocket); override;`
	`destructor Destroy; override;`
	`function LibVersion: String; override;`
	`function LibName: String; override;`
	`function Connect: boolean; override;`
	`function Accept: boolean; override;`
	`function Shutdown: boolean; override;`
	`function BiShutdown: boolean; override;`
	`function SendBuffer(Buffer: TMemory; Len: Integer): Integer; override;`
	`function RecvBuffer(Buffer: TMemory; Len: Integer): Integer; override;`
	`function WaitingData: Integer; override;`
	`function GetSSLVersion: string; override;`
	`function GetPeerSubject: string; override;`
	`function GetPeerIssuer: string; override;`
	`function GetPeerName: string; override;`
	`function GetPeerFingerprint: string; override;`
	`function GetCertInfo: string; override;`

Properties

+ + + + + +

property TLSServer: TCustomTLSInternalServer read FTLSServer write FTLSServer;

Description

Methods

+ + + + + +

constructor Create(const Value: TTCPBlockSocket); override;

+ + + + + +

destructor Destroy; override;

+ + + + + +

function LibVersion: String; override;

+ + + + + +

function LibName: String; override;

+ + + + + +

function Connect: boolean; override;

+See TCustomSSL.Connect and ssl_streamsec for more details.

+ + + + + +

function Accept: boolean; override;

+See TCustomSSL.Accept and ssl_streamsec for more details.

+ + + + + +

function Shutdown: boolean; override;

+ + + + + +

function BiShutdown: boolean; override;

+ + + + + +

function SendBuffer(Buffer: TMemory; Len: Integer): Integer; override;

+ + + + + +

function RecvBuffer(Buffer: TMemory; Len: Integer): Integer; override;

+ + + + + +

function WaitingData: Integer; override;

+ + + + + +

function GetSSLVersion: string; override;

+ + + + + +

function GetPeerSubject: string; override;

+ + + + + +

function GetPeerIssuer: string; override;

+ + + + + +

function GetPeerName: string; override;

+ + + + + +

function GetPeerFingerprint: string; override;

+ + + + + +

function GetCertInfo: string; override;

+See TCustomSSL.GetCertInfo

Properties

+ + + + + +

property TLSServer: TCustomTLSInternalServer read FTLSServer write FTLSServer;

+TLS server for tuning of StreamSecII.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:52 + + ADDED lib/synapse/docs/help/ssl_streamsec.html Index: lib/synapse/docs/help/ssl_streamsec.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/ssl_streamsec.html @@ -0,0 +1,42 @@ + + + + + +ssl_streamsec + + + +

Unit ssl_streamsec

+ + +

Functions and Procedures

Types

Constants

Variables

Description

+SSL plugin for StreamSecII or OpenStreamSecII

+ + +

StreamSecII is native pascal library, you not need any external libraries! + +

You can tune lot of StreamSecII properties by using your GlobalServer. If you not using your GlobalServer, then this plugin create own TSimpleTLSInternalServer instance for each TCP connection. Formore information about GlobalServer usage refer StreamSecII documentation. + +

If you are not using key and certificate by GlobalServer, then you can use properties of this plugin instead, but this have limited features and TCustomSSL.KeyPassword not working properly yet! + +

uses

SysUtils
Classes
blcksock
synsock
synautil
synacode
TlsInternalServer
TlsSynaSock
TlsConst
StreamSecII
Asn1
X509Base
SecUtils

Overview

Classes, Interfaces, Objects and Records

+ + + + + + + + + +

Name	Description
Class `TSSLStreamSec`	class implementing StreamSecII SSL plugin.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:52 + + ADDED lib/synapse/docs/help/synachar.html Index: lib/synapse/docs/help/synachar.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/synachar.html @@ -0,0 +1,560 @@ + + + + + +synachar + + + +

Unit synachar

+ + +

Classes, Interfaces, Objects and Records

Description

+Charset conversion support

+ This unit contains a routines for lot of charset conversions. + +

It using built-in conversion tables or external Iconv library. Iconv is used when needed conversion is known by Iconv library. When Iconv library is not found or Iconv not know requested conversion, then are internal routines used for conversion. (You can disable Iconv support from your program too!) + +

Internal routines knows all major charsets for Europe or America. For East-Asian charsets you must use Iconv library!

uses

Windows
SysUtils
synautil
synacode
synaicnv

Overview

Functions and Procedures

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

function CharsetConversion(const Value: AnsiString; CharFrom: TMimeChar; CharTo: TMimeChar): AnsiString;

function CharsetConversionEx(const Value: AnsiString; CharFrom: TMimeChar; CharTo: TMimeChar; const TransformTable: array of Word): AnsiString;

function CharsetConversionTrans(Value: AnsiString; CharFrom: TMimeChar; CharTo: TMimeChar; const TransformTable: array of Word; Translit: Boolean): AnsiString;

function GetCurCP: TMimeChar;

function GetCurOEMCP: TMimeChar;

function GetCPFromID(Value: AnsiString): TMimeChar;

function GetIDFromCP(Value: TMimeChar): AnsiString;

function NeedCharsetConversion(const Value: AnsiString): Boolean;

function IdealCharsetCoding(const Value: AnsiString; CharFrom: TMimeChar; CharTo: TMimeSetChar): TMimeChar;

function GetBOM(Value: TMimeChar): AnsiString;

function StringToWide(const Value: AnsiString): WideString;

function WideToString(const Value: WideString): AnsiString;

Types

+ + + + + + + +

TMimeChar = (...);

TMimeSetChar = set of TMimeChar;

Constants

+ + + + + + + + + + + + + +

IconvOnlyChars: set of TMimeChar = [UTF_16, UTF_16LE, UTF_32, UTF_32LE,
+    C99, JAVA, ISO_8859_16, KOI8_U, KOI8_RU, CP862, CP866, MAC, MACCE, MACICE,
+    MACCRO, MACRO, MACCYR, MACUK, MACGR, MACTU, MACHEB, MACAR, MACTH, ROMAN8,
+    NEXTSTEP, ARMASCII, GEORGIAN_AC, GEORGIAN_PS, KOI8_T, MULELAO, CP1133,
+    TIS620, CP874, VISCII, TCVN, ISO_IR_14, JIS_X0201, JIS_X0208, JIS_X0212,
+    GB1988_80, GB2312_80, ISO_IR_165, ISO_IR_149, EUC_JP, SHIFT_JIS, CP932,
+    ISO_2022_JP, ISO_2022_JP1, ISO_2022_JP2, GB2312, CP936, GB18030,
+    ISO_2022_CN, ISO_2022_CNE, HZ, EUC_TW, BIG5, CP950, BIG5_HKSCS, EUC_KR,
+    CP949, CP1361, ISO_2022_KR, CP737, CP775, CP853, CP855, CP857, CP858,
+    CP860, CP861, CP863, CP864, CP865, CP869, CP1125];

NoIconvChars: set of TMimeChar = [CP895, UTF_7mod];

Replace_None: array[0..0] of Word =
+    (0);

Replace_Czech: array[0..59] of Word =
+    (
+      $00E1, $0061,
+      $010D, $0063,
+      $010F, $0064,
+      $010E, $0044,
+      $00E9, $0065,
+      $011B, $0065,
+      $00ED, $0069,
+      $0148, $006E,
+      $00F3, $006F,
+      $0159, $0072,
+      $0161, $0073,
+      $0165, $0074,
+      $00FA, $0075,
+      $016F, $0075,
+      $00FD, $0079,
+      $017E, $007A,
+      $00C1, $0041,
+      $010C, $0043,
+      $00C9, $0045,
+      $011A, $0045,
+      $00CD, $0049,
+      $0147, $004E,
+      $00D3, $004F,
+      $0158, $0052,
+      $0160, $0053,
+      $0164, $0054,
+      $00DA, $0055,
+      $016E, $0055,
+      $00DD, $0059,
+      $017D, $005A
+    );

Variables

+ + + + + + + +

DisableIconv: Boolean = False;

IdealCharsets: TMimeSetChar =
+    [ISO_8859_1, ISO_8859_2, ISO_8859_3, ISO_8859_4, ISO_8859_5,
+    ISO_8859_6, ISO_8859_7, ISO_8859_8, ISO_8859_9, ISO_8859_10,
+    KOI8_R, KOI8_U
+     
+    , GB2312, EUC_KR, ISO_2022_JP, EUC_TW
+    
+    ];

Description

Functions and Procedures

+ + + + +

function CharsetConversion(const Value: AnsiString; CharFrom: TMimeChar; CharTo: TMimeChar): AnsiString;

+Convert Value from one charset to another. See: CharsetConversionEx

+ + + + +

function CharsetConversionEx(const Value: AnsiString; CharFrom: TMimeChar; CharTo: TMimeChar; const TransformTable: array of Word): AnsiString;

+Convert Value from one charset to another with additional character conversion. see: Replace_None and Replace_Czech

+ + + + +

function CharsetConversionTrans(Value: AnsiString; CharFrom: TMimeChar; CharTo: TMimeChar; const TransformTable: array of Word; Translit: Boolean): AnsiString;

+Convert Value from one charset to another with additional character conversion. This funtion is similar to CharsetConversionEx, but you can disable transliteration of unconvertible characters.

+ + + + +

function GetCurCP: TMimeChar;

+Returns charset used by operating system.

+ + + + +

function GetCurOEMCP: TMimeChar;

+Returns charset used by operating system as OEM charset. (in Windows DOS box, for example)

+ + + + +

function GetCPFromID(Value: AnsiString): TMimeChar;

+Converting string with charset name to TMimeChar.

+ + + + +

function GetIDFromCP(Value: TMimeChar): AnsiString;

+Converting TMimeChar to string with name of charset.

+ + + + +

function NeedCharsetConversion(const Value: AnsiString): Boolean;

+return True when value need to be converted. (It is not 7-bit ASCII)

+ + + + +

function IdealCharsetCoding(const Value: AnsiString; CharFrom: TMimeChar; CharTo: TMimeSetChar): TMimeChar;

+Finding best target charset from set of TMimeChars with minimal count of unconvertible characters.

+ + + + +

function GetBOM(Value: TMimeChar): AnsiString;

+Return BOM (Byte Order Mark) for given unicode charset.

+ + + + +

function StringToWide(const Value: AnsiString): WideString;

+Convert binary string with unicode content to WideString.

+ + + + +

function WideToString(const Value: WideString): AnsiString;

+Convert WideString to binary string with unicode content.

Types

+ + + + +

TMimeChar = (...);

+Type with all supported charsets.

+ISO_8859_1:
+ISO_8859_2:
+ISO_8859_3:
+ISO_8859_4:
+ISO_8859_5:
+ISO_8859_6:
+ISO_8859_7:
+ISO_8859_8:
+ISO_8859_9:
+ISO_8859_10:
+ISO_8859_13:
+ISO_8859_14:
+ISO_8859_15:
+CP1250:
+CP1251:
+CP1252:
+CP1253:
+CP1254:
+CP1255:
+CP1256:
+CP1257:
+CP1258:
+KOI8_R:
+CP895:
+CP852:
+UCS_2:
+UCS_4:
+UTF_8:
+UTF_7:
+UTF_7mod:
+UCS_2LE:
+UCS_4LE:
+UTF_16:
+UTF_16LE:
+UTF_32:
+UTF_32LE:
+C99:
+JAVA:
+ISO_8859_16:
+KOI8_U:
+KOI8_RU:
+CP862:
+CP866:
+MAC:
+MACCE:
+MACICE:
+MACCRO:
+MACRO:
+MACCYR:
+MACUK:
+MACGR:
+MACTU:
+MACHEB:
+MACAR:
+MACTH:
+ROMAN8:
+NEXTSTEP:
+ARMASCII:
+GEORGIAN_AC:
+GEORGIAN_PS:
+KOI8_T:
+MULELAO:
+CP1133:
+TIS620:
+CP874:
+VISCII:
+TCVN:
+ISO_IR_14:
+JIS_X0201:
+JIS_X0208:
+JIS_X0212:
+GB1988_80:
+GB2312_80:
+ISO_IR_165:
+ISO_IR_149:
+EUC_JP:
+SHIFT_JIS:
+CP932:
+ISO_2022_JP:
+ISO_2022_JP1:
+ISO_2022_JP2:
+GB2312:
+CP936:
+GB18030:
+ISO_2022_CN:
+ISO_2022_CNE:
+HZ:
+EUC_TW:
+BIG5:
+CP950:
+BIG5_HKSCS:
+EUC_KR:
+CP949:
+CP1361:
+ISO_2022_KR:
+CP737:
+CP775:
+CP853:
+CP855:
+CP857:
+CP858:
+CP860:
+CP861:
+CP863:
+CP864:
+CP865:
+CP869:
+CP1125:

+ + + + +

TMimeSetChar = set of TMimeChar;

+Set of any charsets.

Constants

+ + + + +

IconvOnlyChars: set of TMimeChar = [UTF_16, UTF_16LE, UTF_32, UTF_32LE,
+    C99, JAVA, ISO_8859_16, KOI8_U, KOI8_RU, CP862, CP866, MAC, MACCE, MACICE,
+    MACCRO, MACRO, MACCYR, MACUK, MACGR, MACTU, MACHEB, MACAR, MACTH, ROMAN8,
+    NEXTSTEP, ARMASCII, GEORGIAN_AC, GEORGIAN_PS, KOI8_T, MULELAO, CP1133,
+    TIS620, CP874, VISCII, TCVN, ISO_IR_14, JIS_X0201, JIS_X0208, JIS_X0212,
+    GB1988_80, GB2312_80, ISO_IR_165, ISO_IR_149, EUC_JP, SHIFT_JIS, CP932,
+    ISO_2022_JP, ISO_2022_JP1, ISO_2022_JP2, GB2312, CP936, GB18030,
+    ISO_2022_CN, ISO_2022_CNE, HZ, EUC_TW, BIG5, CP950, BIG5_HKSCS, EUC_KR,
+    CP949, CP1361, ISO_2022_KR, CP737, CP775, CP853, CP855, CP857, CP858,
+    CP860, CP861, CP863, CP864, CP865, CP869, CP1125];

+Set of charsets supported by Iconv library only.

+ + + + +

NoIconvChars: set of TMimeChar = [CP895, UTF_7mod];

+Set of charsets supported by internal routines only.

+ + + + +

Replace_None: array[0..0] of Word =
+    (0);

+null character replace table. (Usable for disable charater replacing.)

+ + + + +

Replace_Czech: array[0..59] of Word =
+    (
+      $00E1, $0061,
+      $010D, $0063,
+      $010F, $0064,
+      $010E, $0044,
+      $00E9, $0065,
+      $011B, $0065,
+      $00ED, $0069,
+      $0148, $006E,
+      $00F3, $006F,
+      $0159, $0072,
+      $0161, $0073,
+      $0165, $0074,
+      $00FA, $0075,
+      $016F, $0075,
+      $00FD, $0079,
+      $017E, $007A,
+      $00C1, $0041,
+      $010C, $0043,
+      $00C9, $0045,
+      $011A, $0045,
+      $00CD, $0049,
+      $0147, $004E,
+      $00D3, $004F,
+      $0158, $0052,
+      $0160, $0053,
+      $0164, $0054,
+      $00DA, $0055,
+      $016E, $0055,
+      $00DD, $0059,
+      $017D, $005A
+    );

+Character replace table for remove Czech diakritics.

Variables

+ + + + +

DisableIconv: Boolean = False;

+By this you can generally disable/enable Iconv support.

+ + + + +

IdealCharsets: TMimeSetChar =
+    [ISO_8859_1, ISO_8859_2, ISO_8859_3, ISO_8859_4, ISO_8859_5,
+    ISO_8859_6, ISO_8859_7, ISO_8859_8, ISO_8859_9, ISO_8859_10,
+    KOI8_R, KOI8_U
+     
+    , GB2312, EUC_KR, ISO_2022_JP, EUC_TW
+    
+    ];

+Default set of charsets for IdealCharsetCoding function.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:52 + + ADDED lib/synapse/docs/help/synacode.html Index: lib/synapse/docs/help/synacode.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/synacode.html @@ -0,0 +1,498 @@ + + + + + +synacode + + + +

Unit synacode

+ + +

Classes, Interfaces, Objects and Records

Variables

Description

+Various encoding and decoding support

uses

SysUtils

Overview

Functions and Procedures

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

function DecodeTriplet(const Value: AnsiString; Delimiter: AnsiChar): AnsiString;

function DecodeQuotedPrintable(const Value: AnsiString): AnsiString;

function DecodeURL(const Value: AnsiString): AnsiString;

function EncodeTriplet(const Value: AnsiString; Delimiter: AnsiChar; Specials: TSpecials): AnsiString;

function EncodeQuotedPrintable(const Value: AnsiString): AnsiString;

function EncodeSafeQuotedPrintable(const Value: AnsiString): AnsiString;

function EncodeURLElement(const Value: AnsiString): AnsiString;

function EncodeURL(const Value: AnsiString): AnsiString;

function Decode4to3(const Value, Table: AnsiString): AnsiString;

function Decode4to3Ex(const Value, Table: AnsiString): AnsiString;

function Encode3to4(const Value, Table: AnsiString): AnsiString;

function DecodeBase64(const Value: AnsiString): AnsiString;

function EncodeBase64(const Value: AnsiString): AnsiString;

function DecodeBase64mod(const Value: AnsiString): AnsiString;

function EncodeBase64mod(const Value: AnsiString): AnsiString;

function DecodeUU(const Value: AnsiString): AnsiString;

function EncodeUU(const Value: AnsiString): AnsiString;

function DecodeXX(const Value: AnsiString): AnsiString;

function DecodeYEnc(const Value: AnsiString): AnsiString;

function UpdateCrc32(Value: Byte; Crc32: Integer): Integer;

function Crc32(const Value: AnsiString): Integer;

function UpdateCrc16(Value: Byte; Crc16: Word): Word;

function Crc16(const Value: AnsiString): Word;

function MD5(const Value: AnsiString): AnsiString;

function HMAC_MD5(Text, Key: AnsiString): AnsiString;

function MD5LongHash(const Value: AnsiString; Len: integer): AnsiString;

function SHA1(const Value: AnsiString): AnsiString;

function HMAC_SHA1(Text, Key: AnsiString): AnsiString;

function SHA1LongHash(const Value: AnsiString; Len: integer): AnsiString;

function MD4(const Value: AnsiString): AnsiString;

Types

+ + + + +

TSpecials = set of AnsiChar;

Constants

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

SpecialChar: TSpecials =
+  ['=', '(', ')', '[', ']', '<', '>', ':', ';', ',', '@', '/', '?', '\',
+    '"', '_'];

NonAsciiChar: TSpecials =
+  [#0..#31, #127..#255];

URLFullSpecialChar: TSpecials =
+  [';', '/', '?', ':', '@', '=', '&', '#', '+'];

URLSpecialChar: TSpecials =
+  [#$00..#$20, '_', '<', '>', '"', '%', '{', '}', '|', '\', 'ˆ', '˜', '[', ']',
+    '`', #$7F..#$FF];

TableBase64 =
+    'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=';

TableBase64mod =
+    'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+,=';

TableUU =
+    '`!"#$%&''()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]ˆ_';

TableXX =
+    '+-0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz';

ReTablebase64 =
+    #$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$3E +#$40
+    +#$40 +#$40 +#$3F +#$34 +#$35 +#$36 +#$37 +#$38 +#$39 +#$3A +#$3B +#$3C
+    +#$3D +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$00 +#$01 +#$02 +#$03
+    +#$04 +#$05 +#$06 +#$07 +#$08 +#$09 +#$0A +#$0B +#$0C +#$0D +#$0E +#$0F
+    +#$10 +#$11 +#$12 +#$13 +#$14 +#$15 +#$16 +#$17 +#$18 +#$19 +#$40 +#$40
+    +#$40 +#$40 +#$40 +#$40 +#$1A +#$1B +#$1C +#$1D +#$1E +#$1F +#$20 +#$21
+    +#$22 +#$23 +#$24 +#$25 +#$26 +#$27 +#$28 +#$29 +#$2A +#$2B +#$2C +#$2D
+    +#$2E +#$2F +#$30 +#$31 +#$32 +#$33 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40;

ReTableUU =
+    #$01 +#$02 +#$03 +#$04 +#$05 +#$06 +#$07 +#$08 +#$09 +#$0A +#$0B +#$0C
+    +#$0D +#$0E +#$0F +#$10 +#$11 +#$12 +#$13 +#$14 +#$15 +#$16 +#$17 +#$18
+    +#$19 +#$1A +#$1B +#$1C +#$1D +#$1E +#$1F +#$20 +#$21 +#$22 +#$23 +#$24
+    +#$25 +#$26 +#$27 +#$28 +#$29 +#$2A +#$2B +#$2C +#$2D +#$2E +#$2F +#$30
+    +#$31 +#$32 +#$33 +#$34 +#$35 +#$36 +#$37 +#$38 +#$39 +#$3A +#$3B +#$3C
+    +#$3D +#$3E +#$3F +#$00 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40
+    +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40
+    +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40;

ReTableXX =
+    #$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$00 +#$40
+    +#$01 +#$40 +#$40 +#$02 +#$03 +#$04 +#$05 +#$06 +#$07 +#$08 +#$09 +#$0A
+    +#$0B +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$0C +#$0D +#$0E +#$0F
+    +#$10 +#$11 +#$12 +#$13 +#$14 +#$15 +#$16 +#$17 +#$18 +#$19 +#$1A +#$1B
+    +#$1C +#$1D +#$1E +#$1F +#$20 +#$21 +#$22 +#$23 +#$24 +#$25 +#$40 +#$40
+    +#$40 +#$40 +#$40 +#$40 +#$26 +#$27 +#$28 +#$29 +#$2A +#$2B +#$2C +#$2D
+    +#$2E +#$2F +#$30 +#$31 +#$32 +#$33 +#$34 +#$35 +#$36 +#$37 +#$38 +#$39
+    +#$3A +#$3B +#$3C +#$3D +#$3E +#$3F +#$40 +#$40 +#$40 +#$40 +#$40 +#$40;

Description

Functions and Procedures

+ + + + +

function DecodeTriplet(const Value: AnsiString; Delimiter: AnsiChar): AnsiString;

+Decodes triplet encoding with a given character delimiter. It is used for decoding quoted-printable or URL encoding.

+ + + + +

function DecodeQuotedPrintable(const Value: AnsiString): AnsiString;

+Decodes a string from quoted printable form. (also decodes triplet sequences like '=7F')

+ + + + +

function DecodeURL(const Value: AnsiString): AnsiString;

+Decodes a string of URL encoding. (also decodes triplet sequences like '%7F')

+ + + + +

function EncodeTriplet(const Value: AnsiString; Delimiter: AnsiChar; Specials: TSpecials): AnsiString;

+Performs triplet encoding with a given character delimiter. Used for encoding quoted-printable or URL encoding.

+ + + + +

function EncodeQuotedPrintable(const Value: AnsiString): AnsiString;

+Encodes a string to triplet quoted printable form. All NonAsciiChar are encoded.

+ + + + +

function EncodeSafeQuotedPrintable(const Value: AnsiString): AnsiString;

+Encodes a string to triplet quoted printable form. All NonAsciiChar and SpecialChar are encoded.

+ + + + +

function EncodeURLElement(const Value: AnsiString): AnsiString;

+Encodes a string to URL format. Used for encoding data from a form field in HTTP, etc. (Encodes all critical characters including characters used as URL delimiters ('/',':', etc.)

+ + + + +

function EncodeURL(const Value: AnsiString): AnsiString;

+Encodes a string to URL format. Used to encode critical characters in all URLs.

+ + + + +

function Decode4to3(const Value, Table: AnsiString): AnsiString;

+Decode 4to3 encoding with given table. If some element is not found in table, first item from table is used. This is good for buggy coded items by Microsoft Outlook. This software sometimes using wrong table for UUcode, where is used ' ' instead '`'.

+ + + + +

function Decode4to3Ex(const Value, Table: AnsiString): AnsiString;

+Decode 4to3 encoding with given REVERSE table. Using this function with reverse table is much faster then Decode4to3. This function is used internally for Base64, UU or XX decoding.

+ + + + +

function Encode3to4(const Value, Table: AnsiString): AnsiString;

+Encode by system 3to4 (used by Base64, UU coding, etc) by given table.

+ + + + +

function DecodeBase64(const Value: AnsiString): AnsiString;

+Decode string from base64 format.

+ + + + +

function EncodeBase64(const Value: AnsiString): AnsiString;

+Encodes a string to base64 format.

+ + + + +

function DecodeBase64mod(const Value: AnsiString): AnsiString;

+Decode string from modified base64 format. (used in IMAP, for example.)

+ + + + +

function EncodeBase64mod(const Value: AnsiString): AnsiString;

+Encodes a string to modified base64 format. (used in IMAP, for example.)

+ + + + +

function DecodeUU(const Value: AnsiString): AnsiString;

+Decodes a string from UUcode format.

+ + + + +

function EncodeUU(const Value: AnsiString): AnsiString;

+encode UUcode. it encode only datas, you must also add header and footer for proper encode.

+ + + + +

function DecodeXX(const Value: AnsiString): AnsiString;

+Decodes a string from XXcode format.

+ + + + +

function DecodeYEnc(const Value: AnsiString): AnsiString;

+decode line with Yenc code. This code is sometimes used in newsgroups.

+ + + + +

function UpdateCrc32(Value: Byte; Crc32: Integer): Integer;

+Returns a new CRC32 value after adding a new byte of data.

+ + + + +

function Crc32(const Value: AnsiString): Integer;

+return CRC32 from a value string.

+ + + + +

function UpdateCrc16(Value: Byte; Crc16: Word): Word;

+Returns a new CRC16 value after adding a new byte of data.

+ + + + +

function Crc16(const Value: AnsiString): Word;

+return CRC16 from a value string.

+ + + + +

function MD5(const Value: AnsiString): AnsiString;

+Returns a binary string with a RSA-MD5 hashing of "Value" string.

+ + + + +

function HMAC_MD5(Text, Key: AnsiString): AnsiString;

+Returns a binary string with HMAC-MD5 hash.

+ + + + +

function MD5LongHash(const Value: AnsiString; Len: integer): AnsiString;

+Returns a binary string with a RSA-MD5 hashing of string what is constructed by repeating "value" until length is "Len".

+ + + + +

function SHA1(const Value: AnsiString): AnsiString;

+Returns a binary string with a SHA-1 hashing of "Value" string.

+ + + + +

function HMAC_SHA1(Text, Key: AnsiString): AnsiString;

+Returns a binary string with HMAC-SHA1 hash.

+ + + + +

function SHA1LongHash(const Value: AnsiString; Len: integer): AnsiString;

+Returns a binary string with a SHA-1 hashing of string what is constructed by repeating "value" until length is "Len".

+ + + + +

function MD4(const Value: AnsiString): AnsiString;

+Returns a binary string with a RSA-MD4 hashing of "Value" string.

Types

+ + + + +

TSpecials = set of AnsiChar;

Constants

+ + + + +

SpecialChar: TSpecials =
+  ['=', '(', ')', '[', ']', '<', '>', ':', ';', ',', '@', '/', '?', '\',
+    '"', '_'];

+ + + + +

NonAsciiChar: TSpecials =
+  [#0..#31, #127..#255];

+ + + + +

URLFullSpecialChar: TSpecials =
+  [';', '/', '?', ':', '@', '=', '&', '#', '+'];

+ + + + +

URLSpecialChar: TSpecials =
+  [#$00..#$20, '_', '<', '>', '"', '%', '{', '}', '|', '\', 'ˆ', '˜', '[', ']',
+    '`', #$7F..#$FF];

+ + + + +

TableBase64 =
+    'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=';

+ + + + +

TableBase64mod =
+    'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+,=';

+ + + + +

TableUU =
+    '`!"#$%&''()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]ˆ_';

+ + + + +

TableXX =
+    '+-0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz';

+ + + + +

ReTablebase64 =
+    #$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$3E +#$40
+    +#$40 +#$40 +#$3F +#$34 +#$35 +#$36 +#$37 +#$38 +#$39 +#$3A +#$3B +#$3C
+    +#$3D +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$00 +#$01 +#$02 +#$03
+    +#$04 +#$05 +#$06 +#$07 +#$08 +#$09 +#$0A +#$0B +#$0C +#$0D +#$0E +#$0F
+    +#$10 +#$11 +#$12 +#$13 +#$14 +#$15 +#$16 +#$17 +#$18 +#$19 +#$40 +#$40
+    +#$40 +#$40 +#$40 +#$40 +#$1A +#$1B +#$1C +#$1D +#$1E +#$1F +#$20 +#$21
+    +#$22 +#$23 +#$24 +#$25 +#$26 +#$27 +#$28 +#$29 +#$2A +#$2B +#$2C +#$2D
+    +#$2E +#$2F +#$30 +#$31 +#$32 +#$33 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40;

+ + + + +

ReTableUU =
+    #$01 +#$02 +#$03 +#$04 +#$05 +#$06 +#$07 +#$08 +#$09 +#$0A +#$0B +#$0C
+    +#$0D +#$0E +#$0F +#$10 +#$11 +#$12 +#$13 +#$14 +#$15 +#$16 +#$17 +#$18
+    +#$19 +#$1A +#$1B +#$1C +#$1D +#$1E +#$1F +#$20 +#$21 +#$22 +#$23 +#$24
+    +#$25 +#$26 +#$27 +#$28 +#$29 +#$2A +#$2B +#$2C +#$2D +#$2E +#$2F +#$30
+    +#$31 +#$32 +#$33 +#$34 +#$35 +#$36 +#$37 +#$38 +#$39 +#$3A +#$3B +#$3C
+    +#$3D +#$3E +#$3F +#$00 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40
+    +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40
+    +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40;

+ + + + +

ReTableXX =
+    #$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$00 +#$40
+    +#$01 +#$40 +#$40 +#$02 +#$03 +#$04 +#$05 +#$06 +#$07 +#$08 +#$09 +#$0A
+    +#$0B +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$40 +#$0C +#$0D +#$0E +#$0F
+    +#$10 +#$11 +#$12 +#$13 +#$14 +#$15 +#$16 +#$17 +#$18 +#$19 +#$1A +#$1B
+    +#$1C +#$1D +#$1E +#$1F +#$20 +#$21 +#$22 +#$23 +#$24 +#$25 +#$40 +#$40
+    +#$40 +#$40 +#$40 +#$40 +#$26 +#$27 +#$28 +#$29 +#$2A +#$2B +#$2C +#$2D
+    +#$2E +#$2F +#$30 +#$31 +#$32 +#$33 +#$34 +#$35 +#$36 +#$37 +#$38 +#$39
+    +#$3A +#$3B +#$3C +#$3D +#$3E +#$3F +#$40 +#$40 +#$40 +#$40 +#$40 +#$40;

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:52 + + ADDED lib/synapse/docs/help/synacrypt.TSyna3Des.html Index: lib/synapse/docs/help/synacrypt.TSyna3Des.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/synacrypt.TSyna3Des.html @@ -0,0 +1,59 @@ + + + + + +synacrypt: Class TSyna3Des + + + +

Class TSyna3Des

+ + +

Fields

Properties

Unit

Declaration

+type TSyna3Des = class(TSynaCustomDes)

Description

+Implementation of 3DES encryption

Hierarchy

TObject
TSynaBlockCipher
TSynaCustomDes
TSyna3Des

Overview

Methods

+ + + + + + + + + +

	`function EncryptECB(const InData: AnsiString): AnsiString; override;`
	`function DecryptECB(const InData: AnsiString): AnsiString; override;`

Description

Methods

+ + + + + +

function EncryptECB(const InData: AnsiString): AnsiString; override;

+Encrypt a 64-bit block of data using the ECB method of encryption

+ + + + + +

function DecryptECB(const InData: AnsiString): AnsiString; override;

+Decrypt a 64-bit block of data using the ECB method of decryption

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:52 + + ADDED lib/synapse/docs/help/synacrypt.TSynaAes.html Index: lib/synapse/docs/help/synacrypt.TSynaAes.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/synacrypt.TSynaAes.html @@ -0,0 +1,58 @@ + + + + + +synacrypt: Class TSynaAes + + + +

Class TSynaAes

+ + +

Fields

Properties

Unit

Declaration

+type TSynaAes = class(TSynaBlockCipher)

Description

+Implementation of AES encryption

Hierarchy

TObject
TSynaBlockCipher
TSynaAes

Overview

Methods

+ + + + + + + + + +

	`function EncryptECB(const InData: AnsiString): AnsiString; override;`
	`function DecryptECB(const InData: AnsiString): AnsiString; override;`

Description

Methods

+ + + + + +

function EncryptECB(const InData: AnsiString): AnsiString; override;

+Encrypt a 128-bit block of data using the ECB method of encryption

+ + + + + +

function DecryptECB(const InData: AnsiString): AnsiString; override;

+Decrypt a 128-bit block of data using the ECB method of decryption

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:52 + + ADDED lib/synapse/docs/help/synacrypt.TSynaBlockCipher.html Index: lib/synapse/docs/help/synacrypt.TSynaBlockCipher.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/synacrypt.TSynaBlockCipher.html @@ -0,0 +1,229 @@ + + + + + +synacrypt: Class TSynaBlockCipher + + + +

Class TSynaBlockCipher

+ + +

Fields

Properties

Unit

Declaration

+type TSynaBlockCipher = class(TObject)

Description

+Implementation of common routines block ciphers (dafault size is 64-bits)

+ + +

Do not use this class directly, use descendants only!

Hierarchy

TObject
TSynaBlockCipher

Overview

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`procedure SetIV(const Value: AnsiString); virtual;`
	`function GetIV: AnsiString; virtual;`
	`procedure Reset; virtual;`
	`function EncryptECB(const InData: AnsiString): AnsiString; virtual;`
	`function DecryptECB(const InData: AnsiString): AnsiString; virtual;`
	`function EncryptCBC(const Indata: AnsiString): AnsiString; virtual;`
	`function DecryptCBC(const Indata: AnsiString): AnsiString; virtual;`
	`function EncryptCFB8bit(const Indata: AnsiString): AnsiString; virtual;`
	`function DecryptCFB8bit(const Indata: AnsiString): AnsiString; virtual;`
	`function EncryptCFBblock(const Indata: AnsiString): AnsiString; virtual;`
	`function DecryptCFBblock(const Indata: AnsiString): AnsiString; virtual;`
	`function EncryptOFB(const Indata: AnsiString): AnsiString; virtual;`
	`function DecryptOFB(const Indata: AnsiString): AnsiString; virtual;`
	`function EncryptCTR(const Indata: AnsiString): AnsiString; virtual;`
	`function DecryptCTR(const Indata: AnsiString): AnsiString; virtual;`
	`constructor Create(Key: AnsiString);`

Description

Methods

+ + + + + +

procedure SetIV(const Value: AnsiString); virtual;

+Sets the IV to Value and performs a reset

+ + + + + +

function GetIV: AnsiString; virtual;

+Returns the current chaining information, not the actual IV

+ + + + + +

procedure Reset; virtual;

+Reset any stored chaining information

+ + + + + +

function EncryptECB(const InData: AnsiString): AnsiString; virtual;

+Encrypt a 64-bit block of data using the ECB method of encryption

+ + + + + +

function DecryptECB(const InData: AnsiString): AnsiString; virtual;

+Decrypt a 64-bit block of data using the ECB method of decryption

+ + + + + +

function EncryptCBC(const Indata: AnsiString): AnsiString; virtual;

+Encrypt data using the CBC method of encryption

+ + + + + +

function DecryptCBC(const Indata: AnsiString): AnsiString; virtual;

+Decrypt data using the CBC method of decryption

+ + + + + +

function EncryptCFB8bit(const Indata: AnsiString): AnsiString; virtual;

+Encrypt data using the CFB (8 bit) method of encryption

+ + + + + +

function DecryptCFB8bit(const Indata: AnsiString): AnsiString; virtual;

+Decrypt data using the CFB (8 bit) method of decryption

+ + + + + +

function EncryptCFBblock(const Indata: AnsiString): AnsiString; virtual;

+Encrypt data using the CFB (block) method of encryption

+ + + + + +

function DecryptCFBblock(const Indata: AnsiString): AnsiString; virtual;

+Decrypt data using the CFB (block) method of decryption

+ + + + + +

function EncryptOFB(const Indata: AnsiString): AnsiString; virtual;

+Encrypt data using the OFB method of encryption

+ + + + + +

function DecryptOFB(const Indata: AnsiString): AnsiString; virtual;

+Decrypt data using the OFB method of decryption

+ + + + + +

function EncryptCTR(const Indata: AnsiString): AnsiString; virtual;

+Encrypt data using the CTR method of encryption

+ + + + + +

function DecryptCTR(const Indata: AnsiString): AnsiString; virtual;

+Decrypt data using the CTR method of decryption

+ + + + + +

constructor Create(Key: AnsiString);

+Create a encryptor/decryptor instance and initialize it by the Key.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:52 + + ADDED lib/synapse/docs/help/synacrypt.TSynaCustomDes.html Index: lib/synapse/docs/help/synacrypt.TSynaCustomDes.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/synacrypt.TSynaCustomDes.html @@ -0,0 +1,32 @@ + + + + + +synacrypt: Class TSynaCustomDes + + + +

Class TSynaCustomDes

+ + +

Fields

Methods

Properties

Unit

Declaration

+type TSynaCustomDes = class(TSynaBlockCipher)

Description

+Implementation of common routines for DES encryption

+ + +

Do not use this class directly, use descendants only!

Hierarchy

TObject
TSynaBlockCipher
TSynaCustomDes

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:52 + + ADDED lib/synapse/docs/help/synacrypt.TSynaDes.html Index: lib/synapse/docs/help/synacrypt.TSynaDes.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/synacrypt.TSynaDes.html @@ -0,0 +1,59 @@ + + + + + +synacrypt: Class TSynaDes + + + +

Class TSynaDes

+ + +

Fields

Properties

Unit

Declaration

+type TSynaDes = class(TSynaCustomDes)

Description

+Implementation of DES encryption

Hierarchy

TObject
TSynaBlockCipher
TSynaCustomDes
TSynaDes

Overview

Methods

+ + + + + + + + + +

	`function EncryptECB(const InData: AnsiString): AnsiString; override;`
	`function DecryptECB(const InData: AnsiString): AnsiString; override;`

Description

Methods

+ + + + + +

function EncryptECB(const InData: AnsiString): AnsiString; override;

+Encrypt a 64-bit block of data using the ECB method of encryption

+ + + + + +

function DecryptECB(const InData: AnsiString): AnsiString; override;

+Decrypt a 64-bit block of data using the ECB method of decryption

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:52 + + ADDED lib/synapse/docs/help/synacrypt.html Index: lib/synapse/docs/help/synacrypt.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/synacrypt.html @@ -0,0 +1,125 @@ + + + + + +synacrypt + + + +

Unit synacrypt

+ + +

Variables

Description

+Encryption support

+ + +

Implemented are DES and 3DES encryption/decryption by ECB, CBC, CFB-8bit, CFB-block, OFB and CTR methods.

uses

SysUtils
Classes
synautil
synafpc

Overview

Classes, Interfaces, Objects and Records

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Name	Description
Class `TSynaBlockCipher`	Implementation of common routines block ciphers (dafault size is 64-bits)
Class `TSynaCustomDes`	Implementation of common routines for DES encryption
Class `TSynaDes`	Implementation of DES encryption
Class `TSyna3Des`	Implementation of 3DES encryption
Class `TSynaAes`	Implementation of AES encryption

Functions and Procedures

+ + + + + + + + + + +

function TestDes: boolean;

function Test3Des: boolean;

function TestAes: boolean;

Types

+ + + + +

TDesKeyData = array[0..31] of integer;

Constants

+ + + + + + + +

BC = 4;

MAXROUNDS = 14;

Description

Functions and Procedures

+ + + + +

function TestDes: boolean;

+Call internal test of all DES encryptions. Returns True if all is OK.

+ + + + +

function Test3Des: boolean;

+Call internal test of all 3DES encryptions. Returns True if all is OK.

+ + + + +

function TestAes: boolean;

+Call internal test of all AES encryptions. Returns True if all is OK.

Types

+ + + + +

TDesKeyData = array[0..31] of integer;

+Datatype for holding one DES key data

+ + +

This data type is used internally.

Constants

+ + + + +

BC = 4;

+ + + + +

MAXROUNDS = 14;

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:52 + + ADDED lib/synapse/docs/help/synadbg.TSynaDebug.html Index: lib/synapse/docs/help/synadbg.TSynaDebug.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/synadbg.TSynaDebug.html @@ -0,0 +1,51 @@ + + + + + +synadbg: Class TSynaDebug + + + +

Class TSynaDebug

+ + +

Fields

Properties

Unit

+synadbg

Declaration

+type TSynaDebug = class(TObject)

Description

Hierarchy

TObject
TSynaDebug

Overview

Methods

+ + + + + + + + + +

	`class procedure HookStatus(Sender: TObject; Reason: THookSocketReason; const Value: string);`
	`class procedure HookMonitor(Sender: TObject; Writing: Boolean; const Buffer: TMemory; Len: Integer);`

Description

Methods

+ + + + + +

class procedure HookStatus(Sender: TObject; Reason: THookSocketReason; const Value: string);

+ + + + + +

class procedure HookMonitor(Sender: TObject; Writing: Boolean; const Buffer: TMemory; Len: Integer);

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:52 + + ADDED lib/synapse/docs/help/synadbg.html Index: lib/synapse/docs/help/synadbg.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/synadbg.html @@ -0,0 +1,61 @@ + + + + + +synadbg + + + +

Unit synadbg

+ + +

Types

Constants

Description

+Socket debug tools

+ + +

Routines for help with debugging of events on the Sockets.

uses

blcksock
synsock
synautil
classes
sysutils
synafpc

Overview

Classes, Interfaces, Objects and Records

+ + + + + + + + + +

Name	Description
Class `TSynaDebug`

Functions and Procedures

+ + + + +

procedure AppendToLog(const value: Ansistring);

Variables

+ + + + +

LogFile: string;

Description

Functions and Procedures

+ + + + +

procedure AppendToLog(const value: Ansistring);

Variables

+ + + + +

LogFile: string;

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:52 + + ADDED lib/synapse/docs/help/synafpc.html Index: lib/synapse/docs/help/synafpc.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/synafpc.html @@ -0,0 +1,52 @@ + + + + + +synafpc + + + +

Unit synafpc

+ + +

Classes, Interfaces, Objects and Records

Constants

Variables

Description

uses

Windows

Overview

Functions and Procedures

+ + + + +

procedure Sleep(milliseconds: Cardinal);

Types

+ + + + + + + +

TLibHandle = HModule;

PtrInt = Integer;

Description

Functions and Procedures

+ + + + +

procedure Sleep(milliseconds: Cardinal);

Types

+ + + + +

TLibHandle = HModule;

+ + + + +

PtrInt = Integer;

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:52 + + ADDED lib/synapse/docs/help/synaicnv.html Index: lib/synapse/docs/help/synaicnv.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/synaicnv.html @@ -0,0 +1,194 @@ + + + + + +synaicnv + + + +

Unit synaicnv

+ + +

Classes, Interfaces, Objects and Records

Description

+LibIconv support

+ + +

uses

synafpc
Windows

Overview

Functions and Procedures

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

function SynaIconvOpen(const tocode, fromcode: Ansistring): iconv_t;

function SynaIconvOpenTranslit(const tocode, fromcode: Ansistring): iconv_t;

function SynaIconvOpenIgnore(const tocode, fromcode: Ansistring): iconv_t;

function SynaIconv(cd: iconv_t; inbuf: AnsiString; var outbuf: AnsiString): integer;

function SynaIconvClose(var cd: iconv_t): integer;

function SynaIconvCtl(cd: iconv_t; request: integer; argument: argptr): integer;

function IsIconvloaded: Boolean;

function InitIconvInterface: Boolean;

function DestroyIconvInterface: Boolean;

Types

+ + + + + + + + + + +

size_t = Cardinal;

iconv_t = Pointer;

argptr = iconv_t;

Constants

+ + + + + + + + + + + + + + + + + + + +

DLLIconvName = 'iconv.dll';

ICONV_TRIVIALP = 0;

ICONV_GET_TRANSLITERATE = 1;

ICONV_SET_TRANSLITERATE = 2;

ICONV_GET_DISCARD_ILSEQ = 3;

ICONV_SET_DISCARD_ILSEQ = 4;

Variables

+ + + + +

iconvLibHandle: TLibHandle = 0;

Description

Functions and Procedures

+ + + + +

function SynaIconvOpen(const tocode, fromcode: Ansistring): iconv_t;

+ + + + +

function SynaIconvOpenTranslit(const tocode, fromcode: Ansistring): iconv_t;

+ + + + +

function SynaIconvOpenIgnore(const tocode, fromcode: Ansistring): iconv_t;

+ + + + +

function SynaIconv(cd: iconv_t; inbuf: AnsiString; var outbuf: AnsiString): integer;

+ + + + +

function SynaIconvClose(var cd: iconv_t): integer;

+ + + + +

function SynaIconvCtl(cd: iconv_t; request: integer; argument: argptr): integer;

+ + + + +

function IsIconvloaded: Boolean;

+ + + + +

function InitIconvInterface: Boolean;

+ + + + +

function DestroyIconvInterface: Boolean;

Types

+ + + + +

size_t = Cardinal;

+ + + + +

iconv_t = Pointer;

+ + + + +

argptr = iconv_t;

Constants

+ + + + +

DLLIconvName = 'iconv.dll';

+ + + + +

ICONV_TRIVIALP = 0;

+ + + + +

ICONV_GET_TRANSLITERATE = 1;

+ + + + +

ICONV_SET_TRANSLITERATE = 2;

+ + + + +

ICONV_GET_DISCARD_ILSEQ = 3;

+ + + + +

ICONV_SET_DISCARD_ILSEQ = 4;

Variables

+ + + + +

iconvLibHandle: TLibHandle = 0;

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:52 + + ADDED lib/synapse/docs/help/synaip.html Index: lib/synapse/docs/help/synaip.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/synaip.html @@ -0,0 +1,150 @@ + + + + + +synaip + + + +

Unit synaip

+ + +

Classes, Interfaces, Objects and Records

Constants

Variables

Description

+IP adress support procedures and functions

uses

SysUtils
SynaUtil

Overview

Functions and Procedures

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

function IsIP(const Value: string): Boolean;

function IsIP6(const Value: string): Boolean;

function IPToID(Host: string): Ansistring;

function StrToIp6(value: string): TIp6Bytes;

function Ip6ToStr(value: TIp6Bytes): string;

function StrToIp(value: string): integer;

function IpToStr(value: integer): string;

function ReverseIP(Value: AnsiString): AnsiString;

function ReverseIP6(Value: AnsiString): AnsiString;

function ExpandIP6(Value: AnsiString): AnsiString;

Types

+ + + + + + + +

TIp6Bytes = array [0..15] of Byte;

TIp6Words = array [0..7] of Word;

Description

Functions and Procedures

+ + + + +

function IsIP(const Value: string): Boolean;

+Returns True, if "Value" is a valid IPv4 address. Cannot be a symbolic Name!

+ + + + +

function IsIP6(const Value: string): Boolean;

+Returns True, if "Value" is a valid IPv6 address. Cannot be a symbolic Name!

+ + + + +

function IPToID(Host: string): Ansistring;

+Returns a string with the "Host" ip address converted to binary form.

+ + + + +

function StrToIp6(value: string): TIp6Bytes;

+Convert IPv6 address from their string form to binary byte array.

+ + + + +

function Ip6ToStr(value: TIp6Bytes): string;

+Convert IPv6 address from binary byte array to string form.

+ + + + +

function StrToIp(value: string): integer;

+Convert IPv4 address from their string form to binary.

+ + + + +

function IpToStr(value: integer): string;

+Convert IPv4 address from binary to string form.

+ + + + +

function ReverseIP(Value: AnsiString): AnsiString;

+Convert IPv4 address to reverse form.

+ + + + +

function ReverseIP6(Value: AnsiString): AnsiString;

+Convert IPv6 address to reverse form.

+ + + + +

function ExpandIP6(Value: AnsiString): AnsiString;

+Expand short form of IPv6 address to long form.

Types

+ + + + +

TIp6Bytes = array [0..15] of Byte;

+binary form of IPv6 adress (for string conversion routines)

+ + + + +

TIp6Words = array [0..7] of Word;

+binary form of IPv6 adress (for string conversion routines)

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:52 + + ADDED lib/synapse/docs/help/synamisc.TProxySetting.html Index: lib/synapse/docs/help/synamisc.TProxySetting.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/synamisc.TProxySetting.html @@ -0,0 +1,55 @@ + + + + + +synamisc: record TProxySetting + + + +

record TProxySetting

+ + +

Hierarchy

Methods

Properties

Unit

+synamisc

Declaration

+type TProxySetting = record

Description

+This record contains information about proxy setting.

Overview

Fields

+ + + + + + + + + + +

Host: string;

Port: string;

Bypass: string;

Description

Fields

+ + + + +

Host: string;

+ + + + +

Port: string;

+ + + + +

Bypass: string;

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:52 + + ADDED lib/synapse/docs/help/synamisc.html Index: lib/synapse/docs/help/synamisc.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/synamisc.html @@ -0,0 +1,75 @@ + + + + + +synamisc + + + +

Unit synamisc

+ + +

Types

Constants

Variables

Description

uses

synautil
blcksock
SysUtils
Classes
Windows

Overview

Classes, Interfaces, Objects and Records

+ + + + + + + + + +

Name	Description
record `TProxySetting`	This record contains information about proxy setting.

Functions and Procedures

+ + + + + + + + + + + + + +

procedure WakeOnLan(MAC, IP: string);

function GetDNS: string;

function GetIEProxy(protocol: string): TProxySetting;

function GetLocalIPs: string;

Description

Functions and Procedures

+ + + + +

procedure WakeOnLan(MAC, IP: string);

+By this function you can turn-on computer on network, if this computer supporting Wake-on-lan feature. You need MAC number (network card indentifier) of computer for turn-on. You can also assign target IP addres. If you not specify it, then is used broadcast for delivery magic wake-on packet. However broadcasts workinh only on your local network. When you need to wake-up computer on another network, you must specify any existing IP addres on same network segment as targeting computer.

+ + + + +

function GetDNS: string;

+Autodetect current DNS servers used by system. If is defined more then one DNS server, then result is comma-delimited.

+ + + + +

function GetIEProxy(protocol: string): TProxySetting;

+Autodetect InternetExplorer proxy setting for given protocol. This function working only on windows!

+ + + + +

function GetLocalIPs: string;

+Return all known IP addresses on local system. Addresses are divided by comma.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:52 + + ADDED lib/synapse/docs/help/synaser.ESynaSerError.html Index: lib/synapse/docs/help/synaser.ESynaSerError.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/synaser.ESynaSerError.html @@ -0,0 +1,53 @@ + + + + + +synaser: Class ESynaSerError + + + +

Class ESynaSerError

+ + +

Methods

Properties

Unit

+synaser

Declaration

+type ESynaSerError = class(Exception)

Description

+Exception type for SynaSer errors

Hierarchy

Exception
ESynaSerError

Overview

Fields

+ + + + + + + + + +

	`ErrorCode: integer;`
	`ErrorMessage: string;`

Description

Fields

+ + + + + +

ErrorCode: integer;

+ + + + + +

ErrorMessage: string;

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:52 + + ADDED lib/synapse/docs/help/synaser.TBlockSerial.html Index: lib/synapse/docs/help/synaser.TBlockSerial.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/synaser.TBlockSerial.html @@ -0,0 +1,1002 @@ + + + + + +synaser: Class TBlockSerial + + + +

Class TBlockSerial

+ + +

Unit

+synaser

Declaration

+type TBlockSerial = class(TObject)

Description

+Main class implementing all communication routines

Hierarchy

TObject
TBlockSerial

Overview

Fields

+ + + + + +

DCB: Tdcb;

Methods

	`constructor Create;`
	`destructor Destroy; override;`
	`class function GetVersion: string; virtual;`
	`procedure CloseSocket; virtual;`
	`procedure Config(baud, bits: integer; parity: char; stop: integer; softflow, hardflow: boolean); virtual;`
	`procedure Connect(comport: string); virtual;`
	`procedure SetCommState; virtual;`
	`procedure GetCommState; virtual;`
	`function SendBuffer(buffer: pointer; length: integer): integer; virtual;`
	`procedure SendByte(data: byte); virtual;`
	`procedure SendString(data: AnsiString); virtual;`
	`procedure SendInteger(Data: integer); virtual;`
	`procedure SendBlock(const Data: AnsiString); virtual;`
	`procedure SendStreamRaw(const Stream: TStream); virtual;`
	`procedure SendStream(const Stream: TStream); virtual;`
	`procedure SendStreamIndy(const Stream: TStream); virtual;`
	`function RecvBuffer(buffer: pointer; length: integer): integer; virtual;`
	`function RecvBufferEx(buffer: pointer; length: integer; timeout: integer): integer; virtual;`
	`function RecvBufferStr(Length: Integer; Timeout: Integer): AnsiString; virtual;`
	`function RecvPacket(Timeout: Integer): AnsiString; virtual;`
	`function RecvByte(timeout: integer): byte; virtual;`
	`function RecvTerminated(Timeout: Integer; const Terminator: AnsiString): AnsiString; virtual;`
	`function Recvstring(timeout: integer): AnsiString; virtual;`
	`function RecvInteger(Timeout: Integer): Integer; virtual;`
	`function RecvBlock(Timeout: Integer): AnsiString; virtual;`
	`procedure RecvStreamRaw(const Stream: TStream; Timeout: Integer); virtual;`
	`procedure RecvStreamSize(const Stream: TStream; Timeout: Integer; Size: Integer); virtual;`
	`procedure RecvStream(const Stream: TStream; Timeout: Integer); virtual;`
	`procedure RecvStreamIndy(const Stream: TStream; Timeout: Integer); virtual;`
	`function WaitingData: integer; virtual;`
	`function WaitingDataEx: integer; virtual;`
	`function SendingData: integer; virtual;`
	`procedure EnableRTSToggle(value: boolean); virtual;`
	`procedure Flush; virtual;`
	`procedure Purge; virtual;`
	`function CanRead(Timeout: integer): boolean; virtual;`
	`function CanWrite(Timeout: integer): boolean; virtual;`
	`function CanReadEx(Timeout: integer): boolean; virtual;`
	`function ModemStatus: integer; virtual;`
	`procedure SetBreak(Duration: integer); virtual;`
	`function ATCommand(value: AnsiString): AnsiString; virtual;`
	`function ATConnect(value: AnsiString): AnsiString; virtual;`
	`function SerialCheck(SerialResult: integer): integer; virtual;`
	`procedure ExceptCheck; virtual;`
	`procedure SetSynaError(ErrNumber: integer); virtual;`
	`procedure RaiseSynaError(ErrNumber: integer); virtual;`
	`class function GetErrorDesc(ErrorCode: integer): string;`

Properties

	`property Device: string read FDevice;`
	`property LastError: integer read FLastError;`
	`property LastErrorDesc: string read FLastErrorDesc;`
	`property ATResult: Boolean read FATResult;`
	`property RTS: Boolean write SetRTSF;`
	`property CTS: boolean read GetCTS;`
	`property DTR: Boolean write SetDTRF;`
	`property DSR: boolean read GetDSR;`
	`property Carrier: boolean read GetCarrier;`
	`property Ring: boolean read GetRing;`
	`property InstanceActive: boolean read FInstanceActive;`
	`property MaxSendBandwidth: Integer read FMaxSendBandwidth Write FMaxSendBandwidth;`
	`property MaxRecvBandwidth: Integer read FMaxRecvBandwidth Write FMaxRecvBandwidth;`
	`property MaxBandwidth: Integer Write SetBandwidth;`
	`property SizeRecvBuffer: integer read FRecvBuffer write SetSizeRecvBuffer;`
	`property Tag: integer read FTag write FTag;`
	`property Handle: THandle read Fhandle write FHandle;`
	`property LineBuffer: AnsiString read FBuffer write FBuffer;`
	`property RaiseExcept: boolean read FRaiseExcept write FRaiseExcept;`
	`property OnStatus: THookSerialStatus read FOnStatus write FOnStatus;`
	`property TestDSR: boolean read FTestDSR write FTestDSR;`
	`property TestCTS: boolean read FTestCTS write FTestCTS;`
	`property MaxLineLength: Integer read FMaxLineLength Write FMaxLineLength;`
	`property DeadlockTimeout: Integer read FDeadlockTimeout Write FDeadlockTimeout;`
	`property LinuxLock: Boolean read FLinuxLock write FLinuxLock;`
	`property ConvertLineEnd: Boolean read FConvertLineEnd Write FConvertLineEnd;`
	`property AtTimeout: integer read FAtTimeout Write FAtTimeout;`
	`property InterPacketTimeout: Boolean read FInterPacketTimeout Write FInterPacketTimeout;`

Description

Fields

+ + + + + +

DCB: Tdcb;

+data Control Block with communication parameters. Usable only when you need to call API directly.

Methods

+ + + + + +

constructor Create;

+Object constructor.

+ + + + + +

destructor Destroy; override;

+Object destructor.

+ + + + + +

class function GetVersion: string; virtual;

+Returns a string containing the version number of the library.

+ + + + + +

procedure CloseSocket; virtual;

+Destroy handle in use. It close connection to serial port.

+ + + + + +

procedure Config(baud, bits: integer; parity: char; stop: integer; softflow, hardflow: boolean); virtual;

+Reconfigure communication parameters on the fly. You must be connected to port before!

parameters

baud: Define connection speed. Baud rate can be from 50 to 4000000 bits per second. (it depends on your hardware!)
bits: Number of bits in communication.
parity: Define communication parity (N - None, O - Odd, E - Even, M - Mark or S - Space).
stop: Define number of stopbits. Use constants SB1, SB1andHalf and SB2.
softflow: Enable XON/XOFF handshake.
hardflow: Enable CTS/RTS handshake.

+ + + + + +

procedure Connect(comport: string); virtual;

+Connects to the port indicated by comport. Comport can be used in Windows style (COM2), or in Linux style (/dev/ttyS1). When you use windows style in Linux, then it will be converted to Linux name. And vice versa! However you can specify any device name! (other device names then standart is not converted!) + +

After successfull connection the DTR signal is set (if you not set hardware handshake, then the RTS signal is set, too!) + +

Connection parameters is predefined by your system configuration. If you need use another parameters, then you can use Config method after. Notes: + +

- Remember, the commonly used serial Laplink cable does not support hardware handshake. + +

- Before setting any handshake you must be sure that it is supported by your hardware. + +

- Some serial devices are slow. In some cases you must wait up to a few seconds after connection for the device to respond. + +

- when you connect to a modem device, then is best to test it by an empty AT command. (call ATCommand('AT'))

+ + + + + +

procedure SetCommState; virtual;

+Set communication parameters from the DCB structure (the DCB structure is simulated under Linux).

+ + + + + +

procedure GetCommState; virtual;

+Read communication parameters into the DCB structure (DCB structure is simulated under Linux).

+ + + + + +

function SendBuffer(buffer: pointer; length: integer): integer; virtual;

+Sends Length bytes of data from Buffer through the connected port.

+ + + + + +

procedure SendByte(data: byte); virtual;

+One data BYTE is sent.

+ + + + + +

procedure SendString(data: AnsiString); virtual;

+Send the string in the data parameter. No terminator is appended by this method. If you need to send a string with CR/LF terminator, you must append the CR/LF characters to the data string! + +

Since no terminator is appended, you can use this function for sending binary data too.

+ + + + + +

procedure SendInteger(Data: integer); virtual;

+send four bytes as integer.

+ + + + + +

procedure SendBlock(const Data: AnsiString); virtual;

+send data as one block. Each block begins with integer value with Length of block.

+ + + + + +

procedure SendStreamRaw(const Stream: TStream); virtual;

+send content of stream from current position

+ + + + + +

procedure SendStream(const Stream: TStream); virtual;

+send content of stream as block. see SendBlock

+ + + + + +

procedure SendStreamIndy(const Stream: TStream); virtual;

+send content of stream as block, but this is compatioble with Indy library. (it have swapped lenght of block). See SendStream

+ + + + + +

function RecvBuffer(buffer: pointer; length: integer): integer; virtual;

+Waits until the allocated buffer is filled by received data. Returns number of data bytes received, which equals to the Length value under normal operation. If it is not equal, the communication channel is possibly broken. + +

This method not using any internal buffering, like all others receiving methods. You cannot freely combine this method with all others receiving methods!

+ + + + + +

function RecvBufferEx(buffer: pointer; length: integer; timeout: integer): integer; virtual;

+Method waits until data is received. If no data is received within the Timeout (in milliseconds) period, LastError is set to ErrTimeout. This method is used to read any amount of data (e. g. 1MB), and may be freely combined with all receviving methods what have Timeout parameter, like the Recvstring, RecvByte or RecvTerminated methods.

+ + + + + +

function RecvBufferStr(Length: Integer; Timeout: Integer): AnsiString; virtual;

+It is like recvBufferEx, but data is readed to dynamicly allocated binary string.

+ + + + + +

function RecvPacket(Timeout: Integer): AnsiString; virtual;

+Read all available data and return it in the function result string. This function may be combined with Recvstring, RecvByte or related methods.

+ + + + + +

function RecvByte(timeout: integer): byte; virtual;

+Waits until one data byte is received which is returned as the function result. If no data is received within the Timeout (in milliseconds) period, LastError is set to ErrTimeout.

+ + + + + +

function RecvTerminated(Timeout: Integer; const Terminator: AnsiString): AnsiString; virtual;

+This method waits until a terminated data string is received. This string is terminated by the Terminator string. The resulting string is returned without this termination string! If no data is received within the Timeout (in milliseconds) period, LastError is set to ErrTimeout.

+ + + + + +

function Recvstring(timeout: integer): AnsiString; virtual;

+This method waits until a terminated data string is received. The string is terminated by a CR/LF sequence. The resulting string is returned without the terminator (CR/LF)! If no data is received within the Timeout (in milliseconds) period, LastError is set to ErrTimeout. + +

If ConvertLineEnd is used, then the CR/LF sequence may not be exactly CR/LF. See the description of ConvertLineEnd. + +

+ + + + + +

function RecvInteger(Timeout: Integer): Integer; virtual;

+Waits until four data bytes are received which is returned as the function integer result. If no data is received within the Timeout (in milliseconds) period, LastError is set to ErrTimeout.

+ + + + + +

function RecvBlock(Timeout: Integer): AnsiString; virtual;

+Waits until one data block is received. See SendBlock. If no data is received within the Timeout (in milliseconds) period, LastError is set to ErrTimeout.

+ + + + + +

procedure RecvStreamRaw(const Stream: TStream; Timeout: Integer); virtual;

+Receive all data to stream, until some error occured. (for example timeout)

+ + + + + +

procedure RecvStreamSize(const Stream: TStream; Timeout: Integer; Size: Integer); virtual;

+receive requested count of bytes to stream

+ + + + + +

procedure RecvStream(const Stream: TStream; Timeout: Integer); virtual;

+receive block of data to stream. (Data can be sended by SendStream

+ + + + + +

procedure RecvStreamIndy(const Stream: TStream; Timeout: Integer); virtual;

+receive block of data to stream. (Data can be sended by SendStreamIndy

+ + + + + +

function WaitingData: integer; virtual;

+Returns the number of received bytes waiting for reading. 0 is returned when there is no data waiting.

+ + + + + +

function WaitingDataEx: integer; virtual;

+Same as WaitingData, but in respect to data in the internal LineBuffer.

+ + + + + +

function SendingData: integer; virtual;

+Returns the number of bytes waiting to be sent in the output buffer. 0 is returned when the output buffer is empty.

+ + + + + +

procedure EnableRTSToggle(value: boolean); virtual;

+Enable or disable RTS driven communication (half-duplex). It can be used to communicate with RS485 converters, or other special equipment. If you enable this feature, the system automatically controls the RTS signal. + +

Notes: + +

- On Windows NT (or higher) ir RTS signal driven by system driver. + +

- On Win9x family is used special code for waiting until last byte is sended from your UART. + +

- On Linux you must have kernel 2.1 or higher!

+ + + + + +

procedure Flush; virtual;

+Waits until all data to is sent and buffers are emptied. Warning: On Windows systems is this method returns when all buffers are flushed to the serial port controller, before the last byte is sent!

+ + + + + +

procedure Purge; virtual;

+Unconditionally empty all buffers. It is good when you need to interrupt communication and for cleanups.

+ + + + + +

function CanRead(Timeout: integer): boolean; virtual;

+Returns True, if you can from read any data from the port. Status is tested for a period of time given by the Timeout parameter (in milliseconds). If the value of the Timeout parameter is 0, the status is tested only once and the function returns immediately. If the value of the Timeout parameter is set to -1, the function returns only after it detects data on the port (this may cause the process to hang).

+ + + + + +

function CanWrite(Timeout: integer): boolean; virtual;

+Returns True, if you can write any data to the port (this function is not sending the contents of the buffer). Status is tested for a period of time given by the Timeout parameter (in milliseconds). If the value of the Timeout parameter is 0, the status is tested only once and the function returns immediately. If the value of the Timeout parameter is set to -1, the function returns only after it detects that it can write data to the port (this may cause the process to hang).

+ + + + + +

function CanReadEx(Timeout: integer): boolean; virtual;

+Same as CanRead, but the test is against data in the internal LineBuffer too.

+ + + + + +

function ModemStatus: integer; virtual;

+Returns the status word of the modem. Decoding the status word could yield the status of carrier detect signaland other signals. This method is used internally by the modem status reading properties. You usually do not need to call this method directly.

+ + + + + +

procedure SetBreak(Duration: integer); virtual;

+Send a break signal to the communication device for Duration milliseconds.

+ + + + + +

function ATCommand(value: AnsiString): AnsiString; virtual;

+This function is designed to send AT commands to the modem. The AT command is sent in the Value parameter and the response is returned in the function return value (may contain multiple lines!). If the AT command is processed successfully (modem returns OK), then the ATResult property is set to True. + +

+ + + + + +

function ATConnect(value: AnsiString): AnsiString; virtual;

+This function is used to send connect type AT commands to the modem. It is for commands to switch to connected state. (ATD, ATA, ATO,...) It sends the AT command in the Value parameter and returns the modem's response (may be multiple lines - usually with connection parameters info). If the AT command is processed successfully (the modem returns CONNECT), then the ATResult property is set to True. + +

This function is designed only for AT commands which respond by CONNECT, BUSY, NO DIALTONE NO CARRIER or ERROR. For other AT commands use the ATCommand method. + +

+ + + + + +

function SerialCheck(SerialResult: integer): integer; virtual;

+If you "manually" call API functions, forward their return code in the SerialResult parameter to this function, which evaluates it and sets LastError and LastErrorDesc.

+ + + + + +

procedure ExceptCheck; virtual;

+If LastError is not 0 and exceptions are enabled, then this procedure raises an exception. This method is used internally. You may need it only in special cases.

+ + + + + +

procedure SetSynaError(ErrNumber: integer); virtual;

+Set Synaser to error state with ErrNumber code. Usually used by internal routines.

+ + + + + +

procedure RaiseSynaError(ErrNumber: integer); virtual;

+Raise Synaser error with ErrNumber code. Usually used by internal routines.

+ + + + + +

class function GetErrorDesc(ErrorCode: integer): string;

+Returns the descriptive text associated with ErrorCode. You need this method only in special cases. Description of LastError is now accessible through the LastErrorDesc property.

Properties

+ + + + + +

property Device: string read FDevice;

+True device name of currently used port

+ + + + + +

property LastError: integer read FLastError;

+Error code of last operation. Value is defined by the host operating system, but value 0 is always OK.

+ + + + + +

property LastErrorDesc: string read FLastErrorDesc;

+Human readable description of LastError code.

+ + + + + +

property ATResult: Boolean read FATResult;

+Indicates if the last ATCommand or ATConnect method was successful

+ + + + + +

property RTS: Boolean write SetRTSF;

+Read the value of the RTS signal.

+ + + + + +

property CTS: boolean read GetCTS;

+Indicates the presence of the CTS signal

+ + + + + +

property DTR: Boolean write SetDTRF;

+Use this property to set the value of the DTR signal.

+ + + + + +

property DSR: boolean read GetDSR;

+Exposes the status of the DSR signal.

+ + + + + +

property Carrier: boolean read GetCarrier;

+Indicates the presence of the Carrier signal

+ + + + + +

property Ring: boolean read GetRing;

+Reflects the status of the Ring signal.

+ + + + + +

property InstanceActive: boolean read FInstanceActive;

+indicates if this instance of SynaSer is active. (Connected to some port)

+ + + + + +

property MaxSendBandwidth: Integer read FMaxSendBandwidth Write FMaxSendBandwidth;

+Defines maximum bandwidth for all sending operations in bytes per second. If this value is set to 0 (default), bandwidth limitation is not used.

+ + + + + +

property MaxRecvBandwidth: Integer read FMaxRecvBandwidth Write FMaxRecvBandwidth;

+Defines maximum bandwidth for all receiving operations in bytes per second. If this value is set to 0 (default), bandwidth limitation is not used.

+ + + + + +

property MaxBandwidth: Integer Write SetBandwidth;

+Defines maximum bandwidth for all sending and receiving operations in bytes per second. If this value is set to 0 (default), bandwidth limitation is not used.

+ + + + + +

property SizeRecvBuffer: integer read FRecvBuffer write SetSizeRecvBuffer;

+Size of the Windows internal receive buffer. Default value is usually 4096 bytes. Note: Valid only in Windows versions!

+ + + + + +

property Tag: integer read FTag write FTag;

+Freely usable property

+ + + + + +

property Handle: THandle read Fhandle write FHandle;

+Contains the handle of the open communication port. You may need this value to directly call communication functions outside SynaSer.

+ + + + + +

property LineBuffer: AnsiString read FBuffer write FBuffer;

+Internally used read buffer.

+ + + + + +

property RaiseExcept: boolean read FRaiseExcept write FRaiseExcept;

+If True, communication errors raise exceptions. If False (default), only the LastError value is set.

+ + + + + +

property OnStatus: THookSerialStatus read FOnStatus write FOnStatus;

+This event is triggered when the communication status changes. It can be used to monitor communication status.

+ + + + + +

property TestDSR: boolean read FTestDSR write FTestDSR;

+If you set this property to True, then the value of the DSR signal is tested before every data transfer. It can be used to detect the presence of a communications device.

+ + + + + +

property TestCTS: boolean read FTestCTS write FTestCTS;

+If you set this property to True, then the value of the CTS signal is tested before every data transfer. It can be used to detect the presence of a communications device. Warning: This property cannot be used if you need hardware handshake!

+ + + + + +

property MaxLineLength: Integer read FMaxLineLength Write FMaxLineLength;

+Use this property you to limit the maximum size of LineBuffer (as a protection against unlimited memory allocation for LineBuffer). Default value is 0 - no limit.

+ + + + + +

property DeadlockTimeout: Integer read FDeadlockTimeout Write FDeadlockTimeout;

+This timeout value is used as deadlock protection when trying to send data to (or receive data from) a device that stopped communicating during data transmission (e.g. by physically disconnecting the device). The timeout value is in milliseconds. The default value is 30,000 (30 seconds).

+ + + + + +

property LinuxLock: Boolean read FLinuxLock write FLinuxLock;

+If set to True (default value), port locking is enabled (under Linux only). WARNING: To use this feature, the application must run by a user with full permission to the /var/lock directory!

+ + + + + +

property ConvertLineEnd: Boolean read FConvertLineEnd Write FConvertLineEnd;

+Indicates if non-standard line terminators should be converted to a CR/LF pair (standard DOS line terminator). If True, line terminators CR, single LF or LF/CR are converted to CR/LF. Defaults to False. This property has effect only on the behavior of the RecvString method.

+ + + + + +

property AtTimeout: integer read FAtTimeout Write FAtTimeout;

+Timeout for AT modem based operations

+ + + + + +

property InterPacketTimeout: Boolean read FInterPacketTimeout Write FInterPacketTimeout;

+If True (default), then all timeouts is timeout between two characters. If False, then timeout is overall for whoole reading operation.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:52 + + ADDED lib/synapse/docs/help/synaser.html Index: lib/synapse/docs/help/synaser.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/synaser.html @@ -0,0 +1,459 @@ + + + + + +synaser + + + +

Unit synaser

+ + +

Variables

Description

uses

Windows
registry
synafpc
Classes
SysUtils
synautil

Overview

Classes, Interfaces, Objects and Records

+ + + + + + + + + + + + + +

Name	Description
Class `ESynaSerError`	Exception type for SynaSer errors
Class `TBlockSerial`	Main class implementing all communication routines

Functions and Procedures

+ + + + +

function GetSerialPortNames: string;

Types

+ + + + + + + +

THookSerialReason = (...);

THookSerialStatus = procedure(Sender: TObject; Reason: THookSerialReason; const Value: string) of object;

Constants

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

CR = #$0d;

LF = #$0a;

CRLF = CR + LF;

cSerialChunk = 8192;

LockfileDirectory = '/var/lock';

PortIsClosed = -1;

ErrAlreadyOwned = 9991;

ErrAlreadyInUse = 9992;

ErrWrongParameter = 9993;

ErrPortNotOpen = 9994;

ErrNoDeviceAnswer = 9995;

ErrMaxBuffer = 9996;

ErrTimeout = 9997;

ErrNotRead = 9998;

ErrFrame = 9999;

ErrOverrun = 10000;

ErrRxOver = 10001;

ErrRxParity = 10002;

ErrTxFull = 10003;

dcb_Binary = $00000001;

dcb_ParityCheck = $00000002;

dcb_OutxCtsFlow = $00000004;

dcb_OutxDsrFlow = $00000008;

dcb_DtrControlMask = $00000030;

dcb_DtrControlDisable = $00000000;

dcb_DtrControlEnable = $00000010;

dcb_DtrControlHandshake = $00000020;

dcb_DsrSensivity = $00000040;

dcb_TXContinueOnXoff = $00000080;

dcb_OutX = $00000100;

dcb_InX = $00000200;

dcb_ErrorChar = $00000400;

dcb_NullStrip = $00000800;

dcb_RtsControlMask = $00003000;

dcb_RtsControlDisable = $00000000;

dcb_RtsControlEnable = $00001000;

dcb_RtsControlHandshake = $00002000;

dcb_RtsControlToggle = $00003000;

dcb_AbortOnError = $00004000;

dcb_Reserveds = $FFFF8000;

SB1 = 0;

SB1andHalf = 1;

SB2 = 2;

sOK = 0;

sErr = integer(-1);

Description

Functions and Procedures

+ + + + +

function GetSerialPortNames: string;

+Returns list of existing computer serial ports. Working properly only in Windows!

Types

+ + + + +

THookSerialReason = (...);

+Possible status event types for THookSerialStatus

+HR_SerialClose:
+HR_Connect:
+HR_CanRead:
+HR_CanWrite:
+HR_ReadCount:
+HR_WriteCount:
+HR_Wait:

+ + + + +

THookSerialStatus = procedure(Sender: TObject; Reason: THookSerialReason; const Value: string) of object;

+procedural prototype for status event hooking

Constants

+ + + + +

CR = #$0d;

+ + + + +

LF = #$0a;

+ + + + +

CRLF = CR + LF;

+ + + + +

cSerialChunk = 8192;

+ + + + +

LockfileDirectory = '/var/lock';

+ + + + +

PortIsClosed = -1;

+ + + + +

ErrAlreadyOwned = 9991;

+ + + + +

ErrAlreadyInUse = 9992;

+ + + + +

ErrWrongParameter = 9993;

+ + + + +

ErrPortNotOpen = 9994;

+ + + + +

ErrNoDeviceAnswer = 9995;

+ + + + +

ErrMaxBuffer = 9996;

+ + + + +

ErrTimeout = 9997;

+ + + + +

ErrNotRead = 9998;

+ + + + +

ErrFrame = 9999;

+ + + + +

ErrOverrun = 10000;

+ + + + +

ErrRxOver = 10001;

+ + + + +

ErrRxParity = 10002;

+ + + + +

ErrTxFull = 10003;

+ + + + +

dcb_Binary = $00000001;

+ + + + +

dcb_ParityCheck = $00000002;

+ + + + +

dcb_OutxCtsFlow = $00000004;

+ + + + +

dcb_OutxDsrFlow = $00000008;

+ + + + +

dcb_DtrControlMask = $00000030;

+ + + + +

dcb_DtrControlDisable = $00000000;

+ + + + +

dcb_DtrControlEnable = $00000010;

+ + + + +

dcb_DtrControlHandshake = $00000020;

+ + + + +

dcb_DsrSensivity = $00000040;

+ + + + +

dcb_TXContinueOnXoff = $00000080;

+ + + + +

dcb_OutX = $00000100;

+ + + + +

dcb_InX = $00000200;

+ + + + +

dcb_ErrorChar = $00000400;

+ + + + +

dcb_NullStrip = $00000800;

+ + + + +

dcb_RtsControlMask = $00003000;

+ + + + +

dcb_RtsControlDisable = $00000000;

+ + + + +

dcb_RtsControlEnable = $00001000;

+ + + + +

dcb_RtsControlHandshake = $00002000;

+ + + + +

dcb_RtsControlToggle = $00003000;

+ + + + +

dcb_AbortOnError = $00004000;

+ + + + +

dcb_Reserveds = $FFFF8000;

+ + + + +

SB1 = 0;

+stopbit value for 1 stopbit

+ + + + +

SB1andHalf = 1;

+stopbit value for 1.5 stopbit

+ + + + +

SB2 = 2;

+stopbit value for 2 stopbits

+ + + + +

sOK = 0;

+ + + + +

sErr = integer(-1);

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:52 + + ADDED lib/synapse/docs/help/synautil.html Index: lib/synapse/docs/help/synautil.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/synautil.html @@ -0,0 +1,763 @@ + + + + + +synautil + + + +

Unit synautil

+ + +

Classes, Interfaces, Objects and Records

Types

Constants

Description

uses

Windows
SysUtils
Classes
SynaFpc

Overview

Functions and Procedures

function TimeZoneBias: integer;

function TimeZone: string;

function Rfc822DateTime(t: TDateTime): string;

function CDateTime(t: TDateTime): string;

function SimpleDateTime(t: TDateTime): string;

function AnsiCDateTime(t: TDateTime): string;

function GetMonthNumber(Value: String): integer;

function GetTimeFromStr(Value: string): TDateTime;

function GetDateMDYFromStr(Value: string): TDateTime;

function DecodeRfcDateTime(Value: string): TDateTime;

function GetUTTime: TDateTime;

function SetUTTime(Newdt: TDateTime): Boolean;

function GetTick: LongWord;

function TickDelta(TickOld, TickNew: LongWord): LongWord;

function CodeInt(Value: Word): Ansistring;

function DecodeInt(const Value: Ansistring; Index: Integer): Word;

function CodeLongInt(Value: LongInt): Ansistring;

function DecodeLongInt(const Value: Ansistring; Index: Integer): LongInt;

function DumpStr(const Buffer: Ansistring): string;

function DumpExStr(const Buffer: Ansistring): string;

procedure Dump(const Buffer: AnsiString; DumpFile: string);

procedure DumpEx(const Buffer: AnsiString; DumpFile: string);

function TrimSPLeft(const S: string): string;

function TrimSPRight(const S: string): string;

function TrimSP(const S: string): string;

function SeparateLeft(const Value, Delimiter: string): string;

function SeparateRight(const Value, Delimiter: string): string;

function GetParameter(const Value, Parameter: string): string;

procedure ParseParametersEx(Value, Delimiter: string; const Parameters: TStrings);

procedure ParseParameters(Value: string; const Parameters: TStrings);

function IndexByBegin(Value: string; const List: TStrings): integer;

function GetEmailAddr(const Value: string): string;

function GetEmailDesc(Value: string): string;

function StrToHex(const Value: Ansistring): string;

function IntToBin(Value: Integer; Digits: Byte): string;

function BinToInt(const Value: string): Integer;

function ParseURL(URL: string; var Prot, User, Pass, Host, Port, Path, Para: string): string;

function ReplaceString(Value, Search, Replace: AnsiString): AnsiString;

function RPosEx(const Sub, Value: string; From: integer): Integer;

function RPos(const Sub, Value: String): Integer;

function FetchBin(var Value: string; const Delimiter: string): string;

function Fetch(var Value: string; const Delimiter: string): string;

function FetchEx(var Value: string; const Delimiter, Quotation: string): string;

function IsBinaryString(const Value: AnsiString): Boolean;

function PosCRLF(const Value: AnsiString; var Terminator: AnsiString): integer;

Procedure StringsTrim(const value: TStrings);

function PosFrom(const SubStr, Value: String; From: integer): integer;

function IncPoint(const p: pointer; Value: integer): pointer;

function GetBetween(const PairBegin, PairEnd, Value: string): string;

function CountOfChar(const Value: string; Chr: char): integer;

function UnquoteStr(const Value: string; Quote: Char): string;

function QuoteStr(const Value: string; Quote: Char): string;

procedure HeadersToList(const Value: TStrings);

procedure ListToHeaders(const Value: TStrings);

function SwapBytes(Value: integer): integer;

function ReadStrFromStream(const Stream: TStream; len: integer): AnsiString;

procedure WriteStrToStream(const Stream: TStream; Value: AnsiString);

function GetTempFile(const Dir, prefix: AnsiString): AnsiString;

function PadString(const Value: AnsiString; len: integer; Pad: AnsiChar): AnsiString;

function XorString(Indata1, Indata2: AnsiString): AnsiString;

function NormalizeHeader(Value: TStrings; var Index: Integer): string;

procedure SearchForLineBreak(var APtr:PANSIChar; AEtx:PANSIChar; out ABol:PANSIChar; out ALength:integer);

procedure SkipLineBreak(var APtr:PANSIChar; AEtx:PANSIChar);

procedure SkipNullLines (var APtr:PANSIChar; AEtx:PANSIChar);

procedure CopyLinesFromStreamUntilNullLine(var APtr:PANSIChar; AEtx:PANSIChar; ALines:TStrings);

procedure CopyLinesFromStreamUntilBoundary(var APtr:PANSIChar; AEtx:PANSIChar; ALines:TStrings; const ABoundary:ANSIString);

function SearchForBoundary (var APtr:PANSIChar; AEtx:PANSIChar; const ABoundary:ANSIString): PANSIChar;

function MatchBoundary (ABOL,AETX:PANSIChar; const ABoundary:ANSIString): PANSIChar;

function MatchLastBoundary (ABOL,AETX:PANSIChar; const ABoundary:ANSIString): PANSIChar;

function BuildStringFromBuffer (AStx,AEtx:PANSIChar): ANSIString;

Variables

+ + + + +

CustomMonthNames: array[1..12] of string;

Description

Functions and Procedures

+ + + + +

function TimeZoneBias: integer;

+Return your timezone bias from UTC time in minutes.

+ + + + +

function TimeZone: string;

+Return your timezone bias from UTC time in string representation like "+0200".

+ + + + +

function Rfc822DateTime(t: TDateTime): string;

+Returns current time in format defined in RFC-822. Useful for SMTP messages, but other protocols use this time format as well. Results contains the timezone specification. Four digit year is used to break any Y2K concerns. (Example 'Fri, 15 Oct 1999 21:14:56 +0200')

+ + + + +

function CDateTime(t: TDateTime): string;

+Returns date and time in format defined in C compilers in format "mmm dd hh:nn:ss"

+ + + + +

function SimpleDateTime(t: TDateTime): string;

+Returns date and time in format defined in format 'yymmdd hhnnss'

+ + + + +

function AnsiCDateTime(t: TDateTime): string;

+Returns date and time in format defined in ANSI C compilers in format "ddd mmm d hh:nn:ss yyyy"

+ + + + +

function GetMonthNumber(Value: String): integer;

+Decode three-letter string with name of month to their month number. If string not match any month name, then is returned 0. For parsing are used predefined names for English, French and German and names from system locale too.

+ + + + +

function GetTimeFromStr(Value: string): TDateTime;

+Return decoded time from given string. Time must be witch separator ':'. You can use "hh:mm" or "hh:mm:ss".

+ + + + +

function GetDateMDYFromStr(Value: string): TDateTime;

+Decode string in format "m-d-y" to TDateTime type.

+ + + + +

function DecodeRfcDateTime(Value: string): TDateTime;

+Decode various string representations of date and time to Tdatetime type. This function do all timezone corrections too! This function can decode lot of formats like:

+ +

+ ddd, d mmm yyyy hh:mm:ss
+ ddd, d mmm yy hh:mm:ss
+ ddd, mmm d yyyy hh:mm:ss
+ ddd mmm dd hh:mm:ss yyyy

+ +

and more with lot of modifications, include:

+ +

+Sun, 06 Nov 1994 08:49:37 GMT    ; RFC 822, updated by RFC 1123
+Sunday, 06-Nov-94 08:49:37 GMT   ; RFC 850, obsoleted by RFC 1036
+Sun Nov  6 08:49:37 1994         ; ANSI C

+ +

+ + + + +

function GetUTTime: TDateTime;

+Return current system date and time in UTC timezone.

+ + + + +

function SetUTTime(Newdt: TDateTime): Boolean;

+Set Newdt as current system date and time in UTC timezone. This function work only if you have administrator rights!

+ + + + +

function GetTick: LongWord;

+Return current value of system timer with precizion 1 millisecond. Good for measure time difference.

+ + + + +

function TickDelta(TickOld, TickNew: LongWord): LongWord;

+Return difference between two timestamps. It working fine only for differences smaller then maxint. (difference must be smaller then 24 days.)

+ + + + +

function CodeInt(Value: Word): Ansistring;

+Return two characters, which ordinal values represents the value in byte format. (High-endian)

+ + + + +

function DecodeInt(const Value: Ansistring; Index: Integer): Word;

+Decodes two characters located at "Index" offset position of the "Value" string to Word values.

+ + + + +

function CodeLongInt(Value: LongInt): Ansistring;

+Return four characters, which ordinal values represents the value in byte format. (High-endian)

+ + + + +

function DecodeLongInt(const Value: Ansistring; Index: Integer): LongInt;

+Decodes four characters located at "Index" offset position of the "Value" string to LongInt values.

+ + + + +

function DumpStr(const Buffer: Ansistring): string;

+Dump binary buffer stored in a string to a result string.

+ + + + +

function DumpExStr(const Buffer: Ansistring): string;

+Dump binary buffer stored in a string to a result string. All bytes with code of character is written as character, not as hexadecimal value.

+ + + + +

procedure Dump(const Buffer: AnsiString; DumpFile: string);

+Dump binary buffer stored in a string to a file with DumpFile filename.

+ + + + +

procedure DumpEx(const Buffer: AnsiString; DumpFile: string);

+Dump binary buffer stored in a string to a file with DumpFile filename. All bytes with code of character is written as character, not as hexadecimal value.

+ + + + +

function TrimSPLeft(const S: string): string;

+Like TrimLeft, but remove only spaces, not control characters!

+ + + + +

function TrimSPRight(const S: string): string;

+Like TrimRight, but remove only spaces, not control characters!

+ + + + +

function TrimSP(const S: string): string;

+Like Trim, but remove only spaces, not control characters!

+ + + + +

function SeparateLeft(const Value, Delimiter: string): string;

+Returns a portion of the "Value" string located to the left of the "Delimiter" string. If a delimiter is not found, results is original string.

+ + + + +

function SeparateRight(const Value, Delimiter: string): string;

+Returns the portion of the "Value" string located to the right of the "Delimiter" string. If a delimiter is not found, results is original string.

+ + + + +

function GetParameter(const Value, Parameter: string): string;

+Returns parameter value from string in format: parameter1="value1"; parameter2=value2

+ + + + +

procedure ParseParametersEx(Value, Delimiter: string; const Parameters: TStrings);

+parse value string with elements differed by Delimiter into stringlist.

+ + + + +

procedure ParseParameters(Value: string; const Parameters: TStrings);

+parse value string with elements differed by ';' into stringlist.

+ + + + +

function IndexByBegin(Value: string; const List: TStrings): integer;

+Index of string in stringlist with same beginning as Value is returned.

+ + + + +

function GetEmailAddr(const Value: string): string;

+Returns only the e-mail portion of an address from the full address format. i.e. returns 'nobody@somewhere.com' from '"someone" <nobody@somewhere.com>'

+ + + + +

function GetEmailDesc(Value: string): string;

+Returns only the description part from a full address format. i.e. returns 'someone' from '"someone" <nobody@somewhere.com>'

+ + + + +

function StrToHex(const Value: Ansistring): string;

+Returns a string with hexadecimal digits representing the corresponding values of the bytes found in "Value" string.

+ + + + +

function IntToBin(Value: Integer; Digits: Byte): string;

+Returns a string of binary "Digits" representing "Value".

+ + + + +

function BinToInt(const Value: string): Integer;

+Returns an integer equivalent of the binary string in "Value". (i.e. ('10001010') returns 138)

+ + + + +

function ParseURL(URL: string; var Prot, User, Pass, Host, Port, Path, Para: string): string;

+Parses a URL to its various components.

+ + + + +

function ReplaceString(Value, Search, Replace: AnsiString): AnsiString;

+Replaces all "Search" string values found within "Value" string, with the "Replace" string value.

+ + + + +

function RPosEx(const Sub, Value: string; From: integer): Integer;

+It is like RPos, but search is from specified possition.

+ + + + +

function RPos(const Sub, Value: String): Integer;

+It is like POS function, but from right side of Value string.

+ + + + +

function FetchBin(var Value: string; const Delimiter: string): string;

+Like Fetch, but working with binary strings, not with text.

+ + + + +

function Fetch(var Value: string; const Delimiter: string): string;

+Fetch string from left of Value string.

+ + + + +

function FetchEx(var Value: string; const Delimiter, Quotation: string): string;

+Fetch string from left of Value string. This function ignore delimitesr inside quotations.

+ + + + +

function IsBinaryString(const Value: AnsiString): Boolean;

+If string is binary string (contains non-printable characters), then is returned true.

+ + + + +

function PosCRLF(const Value: AnsiString; var Terminator: AnsiString): integer;

+return position of string terminator in string. If terminator found, then is returned in terminator parameter. Possible line terminators are: CRLF, LFCR, CR, LF

+ + + + +

Procedure StringsTrim(const value: TStrings);

+Delete empty strings from end of stringlist.

+ + + + +

function PosFrom(const SubStr, Value: String; From: integer): integer;

+Like Pos function, buf from given string possition.

+ + + + +

function IncPoint(const p: pointer; Value: integer): pointer;

+Increase pointer by value.

+ + + + +

function GetBetween(const PairBegin, PairEnd, Value: string): string;

+Get string between PairBegin and PairEnd. This function respect nesting. For example:

+ +

+ Value is: 'Hi! (hello(yes!))'
+ pairbegin is: '('
+ pairend is: ')'
+ In this case result is: 'hello(yes!)'

+ +

+ + + + +

function CountOfChar(const Value: string; Chr: char): integer;

+Return count of Chr in Value string.

+ + + + +

function UnquoteStr(const Value: string; Quote: Char): string;

+Remove quotation from Value string. If Value is not quoted, then return same string without any modification.

+ + + + +

function QuoteStr(const Value: string; Quote: Char): string;

+Quote Value string. If Value contains some Quote chars, then it is doubled.

+ + + + +

procedure HeadersToList(const Value: TStrings);

+Convert lines in stringlist from 'name: value' form to 'name=value' form.

+ + + + +

procedure ListToHeaders(const Value: TStrings);

+Convert lines in stringlist from 'name=value' form to 'name: value' form.

+ + + + +

function SwapBytes(Value: integer): integer;

+swap bytes in integer.

+ + + + +

function ReadStrFromStream(const Stream: TStream; len: integer): AnsiString;

+read string with requested length form stream.

+ + + + +

procedure WriteStrToStream(const Stream: TStream; Value: AnsiString);

+write string to stream.

+ + + + +

function GetTempFile(const Dir, prefix: AnsiString): AnsiString;

+Return filename of new temporary file in Dir (if empty, then default temporary directory is used) and with optional filename prefix.

+ + + + +

function PadString(const Value: AnsiString; len: integer; Pad: AnsiChar): AnsiString;

+Return padded string. If length is greater, string is truncated. If length is smaller, string is padded by Pad character.

+ + + + +

function XorString(Indata1, Indata2: AnsiString): AnsiString;

+XOR each byte in the strings

+ + + + +

function NormalizeHeader(Value: TStrings; var Index: Integer): string;

+Read header from "Value" stringlist beginning at "Index" position. If header is Splitted into multiple lines, then this procedure de-split it into one line.

+ + + + +

procedure SearchForLineBreak(var APtr:PANSIChar; AEtx:PANSIChar; out ABol:PANSIChar; out ALength:integer);

+Search for one of line terminators CR, LF or NUL. Return position of the line beginning and length of text.

+ + + + +

procedure SkipLineBreak(var APtr:PANSIChar; AEtx:PANSIChar);

+Skip both line terminators CR LF (if any). Move APtr position forward.

+ + + + +

procedure SkipNullLines (var APtr:PANSIChar; AEtx:PANSIChar);

+Skip all blank lines in a buffer starting at APtr and move APtr position forward.

+ + + + +

procedure CopyLinesFromStreamUntilNullLine(var APtr:PANSIChar; AEtx:PANSIChar; ALines:TStrings);

+Copy all lines from a buffer starting at APtr to ALines until empty line or end of the buffer is reached. Move APtr position forward).

+ + + + +

procedure CopyLinesFromStreamUntilBoundary(var APtr:PANSIChar; AEtx:PANSIChar; ALines:TStrings; const ABoundary:ANSIString);

+Copy all lines from a buffer starting at APtr to ALines until ABoundary or end of the buffer is reached. Move APtr position forward).

+ + + + +

function SearchForBoundary (var APtr:PANSIChar; AEtx:PANSIChar; const ABoundary:ANSIString): PANSIChar;

+Search ABoundary in a buffer starting at APtr. Return beginning of the ABoundary. Move APtr forward behind a trailing CRLF if any).

+ + + + +

function MatchBoundary (ABOL,AETX:PANSIChar; const ABoundary:ANSIString): PANSIChar;

+Compare a text at position ABOL with ABoundary and return position behind the match (including a trailing CRLF if any).

+ + + + +

function MatchLastBoundary (ABOL,AETX:PANSIChar; const ABoundary:ANSIString): PANSIChar;

+Compare a text at position ABOL with ABoundary + the last boundary suffix and return position behind the match (including a trailing CRLF if any).

+ + + + +

function BuildStringFromBuffer (AStx,AEtx:PANSIChar): ANSIString;

+Copy data from a buffer starting at position APtr and delimited by AEtx position into ANSIString.

Variables

+ + + + +

CustomMonthNames: array[1..12] of string;

+can be used for your own months strings for GetMonthNumber

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:52 + + ADDED lib/synapse/docs/help/tip_data.js Index: lib/synapse/docs/help/tip_data.js ================================================================== --- /dev/null +++ lib/synapse/docs/help/tip_data.js @@ -0,0 +1,1739 @@ +var s = new Array() + +s[0] = "asn1util^asn1util.html^Utilities for handling ASN.1 BER encoding^ By this unit you can parse ASN.1 BER encoded data to elements or build back any elements to ASN.1 BER encoded buffer. You can dump ASN.1 BER encoded data to human readable form for easy debugging, too.

Supported element types are: ASN1_BOOL, ASN1_INT, ASN1_OCTSTR, ASN1_NULL, ASN1_OBJID, ASN1_ENUM, ASN1_SEQ, ASN1_SETOF, ASN1_IPADDR, ASN1_COUNTER, ASN1_GAUGE, ASN1_TIMETICKS, ASN1_OPAQUE

For sample of using, look to TSNMPSend or TLDAPSendclass. ^0" +s[1] = "asn1util.ASN1_BOOL^asn1util.html#ASN1_BOOL^^ ^0" +s[2] = "asn1util.ASN1_INT^asn1util.html#ASN1_INT^^ ^0" +s[3] = "asn1util.ASN1_OCTSTR^asn1util.html#ASN1_OCTSTR^^ ^0" +s[4] = "asn1util.ASN1_NULL^asn1util.html#ASN1_NULL^^ ^0" +s[5] = "asn1util.ASN1_OBJID^asn1util.html#ASN1_OBJID^^ ^0" +s[6] = "asn1util.ASN1_ENUM^asn1util.html#ASN1_ENUM^^ ^0" +s[7] = "asn1util.ASN1_SEQ^asn1util.html#ASN1_SEQ^^ ^0" +s[8] = "asn1util.ASN1_SETOF^asn1util.html#ASN1_SETOF^^ ^0" +s[9] = "asn1util.ASN1_IPADDR^asn1util.html#ASN1_IPADDR^^ ^0" +s[10] = "asn1util.ASN1_COUNTER^asn1util.html#ASN1_COUNTER^^ ^0" +s[11] = "asn1util.ASN1_GAUGE^asn1util.html#ASN1_GAUGE^^ ^0" +s[12] = "asn1util.ASN1_TIMETICKS^asn1util.html#ASN1_TIMETICKS^^ ^0" +s[13] = "asn1util.ASN1_OPAQUE^asn1util.html#ASN1_OPAQUE^^ ^0" +s[14] = "asn1util.ASNEncOIDItem^asn1util.html#ASNEncOIDItem^^Encodes OID item to binary form. ^0" +s[15] = "asn1util.ASNDecOIDItem^asn1util.html#ASNDecOIDItem^^Decodes an OID item of the next element in the "Buffer" from the "Start" position. ^0" +s[16] = "asn1util.ASNEncLen^asn1util.html#ASNEncLen^^Encodes the length of ASN.1 element to binary. ^0" +s[17] = "asn1util.ASNDecLen^asn1util.html#ASNDecLen^^Decodes length of next element in "Buffer" from the "Start" position. ^0" +s[18] = "asn1util.ASNEncInt^asn1util.html#ASNEncInt^^Encodes a signed integer to ASN.1 binary ^0" +s[19] = "asn1util.ASNEncUInt^asn1util.html#ASNEncUInt^^Encodes unsigned integer into ASN.1 binary ^0" +s[20] = "asn1util.ASNObject^asn1util.html#ASNObject^^Encodes ASN.1 object to binary form. ^0" +s[21] = "asn1util.ASNItem^asn1util.html#ASNItem^^Beginning with the "Start" position, decode the ASN.1 item of the next element in "Buffer". Type of item is stored in "ValueType." ^0" +s[22] = "asn1util.MibToId^asn1util.html#MibToId^^Encodes an MIB OID string to binary form. ^0" +s[23] = "asn1util.IdToMib^asn1util.html#IdToMib^^Decodes MIB OID from binary form to string form. ^0" +s[24] = "asn1util.IntMibToStr^asn1util.html#IntMibToStr^^Encodes an one number from MIB OID to binary form. (used internally from MibToId) ^0" +s[25] = "asn1util.ASNdump^asn1util.html#ASNdump^^Convert ASN.1 BER encoded buffer to human readable form for debugging. ^0" +s[26] = "blcksock^blcksock.html^^ ^0" +s[27] = "blcksock.ESynapseError^blcksock.ESynapseError.html^Exception clas used by Synapse^ When you enable generating of exceptions, this exception is raised by Synapse's units. ^0" +s[28] = "blcksock.ESynapseError.ErrorCode^blcksock.ESynapseError.html#ErrorCode^^Code of error. Value depending on used operating system ^0" +s[29] = "blcksock.ESynapseError.ErrorMessage^blcksock.ESynapseError.html#ErrorMessage^^Human readable description of error. ^0" +s[30] = "blcksock.TSynaOption^blcksock.TSynaOption.html^this object is used for remember delayed socket option set.^ ^0" +s[31] = "blcksock.TSynaOption.Option^blcksock.TSynaOption.html#Option^^ ^0" +s[32] = "blcksock.TSynaOption.Enabled^blcksock.TSynaOption.html#Enabled^^ ^0" +s[33] = "blcksock.TSynaOption.Value^blcksock.TSynaOption.html#Value^^ ^0" +s[34] = "blcksock.TBlockSocket^blcksock.TBlockSocket.html^Basic IP object.^ This is parent class for other class with protocol implementations. Do not use this class directly! Use TICMPBlockSocket, TRAWBlockSocket, TTCPBlockSocket or TUDPBlockSocket instead. ^0" +s[35] = "blcksock.TBlockSocket.Create^blcksock.TBlockSocket.html#Create^^ ^0" +s[36] = "blcksock.TBlockSocket.CreateAlternate^blcksock.TBlockSocket.html#CreateAlternate^^Create object and load all necessary socket library. What library is loaded is described by STUB parameter. If STUB is empty string, then is loaded default libraries. ^0" +s[37] = "blcksock.TBlockSocket.Destroy^blcksock.TBlockSocket.html#Destroy^^ ^0" +s[38] = "blcksock.TBlockSocket.CreateSocket^blcksock.TBlockSocket.html#CreateSocket^^If Family is not SF_Any, then create socket with type defined in Family property. If family is SF_Any, then do nothing! (socket is created automaticly when you know what type of socket you need to create. (i.e. inside Connect or Bind call.) When socket is created, then is aplyed all stored delayed socket options. ^0" +s[39] = "blcksock.TBlockSocket.CreateSocketByName^blcksock.TBlockSocket.html#CreateSocketByName^^It create socket. Address resolving of Value tells what type of socket is created. If Value is resolved as IPv4 IP, then is created IPv4 socket. If value is resolved as IPv6 address, then is created IPv6 socket. ^0" +s[40] = "blcksock.TBlockSocket.CloseSocket^blcksock.TBlockSocket.html#CloseSocket^^Destroy socket in use. This method is also automatically called from object destructor. ^0" +s[41] = "blcksock.TBlockSocket.AbortSocket^blcksock.TBlockSocket.html#AbortSocket^^Abort any work on Socket and destroy them. ^0" +s[42] = "blcksock.TBlockSocket.Bind^blcksock.TBlockSocket.html#Bind^^Connects socket to local IP address and PORT. IP address may be numeric or symbolic ('192.168.74.50', 'cosi.nekde.cz', 'ff08::1'). The same for PORT - it may be number or mnemonic port ('23', 'telnet').

If port value is '0', system chooses itself and conects unused port in the range 1024 to 4096 (this depending by operating system!). Structure LocalSin is filled after calling this method.

Note: If you call this on non-created socket, then socket is created automaticly.

Warning: when you call : Bind('0.0.0.0','0'); then is nothing done! In this case is used implicit system bind instead. ^0" +s[43] = "blcksock.TBlockSocket.Connect^blcksock.TBlockSocket.html#Connect^^Connects socket to remote IP address and PORT. The same rules as with Bind method are valid. The only exception is that PORT with 0 value will not be connected!

Structures LocalSin and RemoteSin will be filled with valid values.

When you call this on non-created socket, then socket is created automaticly. Type of created socket is by Family property. If is used SF_IP4, then is created socket for IPv4. If is used SF_IP6, then is created socket for IPv6. When you have family on SF_Any (default!), then type of created socket is determined by address resolving of destination address. (Not work properly on prilimitary winsock IPv6 support!) ^0" +s[44] = "blcksock.TBlockSocket.Listen^blcksock.TBlockSocket.html#Listen^^Sets socket to receive mode for new incoming connections. It is necessary to use TBlockSocket.Bind function call before this method to select receiving port! ^0" +s[45] = "blcksock.TBlockSocket.Accept^blcksock.TBlockSocket.html#Accept^^Waits until new incoming connection comes. After it comes a new socket is automatically created (socket handler is returned by this function as result). ^0" +s[46] = "blcksock.TBlockSocket.SendBuffer^blcksock.TBlockSocket.html#SendBuffer^^Sends data of LENGTH from BUFFER address via connected socket. System automatically splits data to packets. ^0" +s[47] = "blcksock.TBlockSocket.SendByte^blcksock.TBlockSocket.html#SendByte^^One data BYTE is sent via connected socket. ^0" +s[48] = "blcksock.TBlockSocket.SendString^blcksock.TBlockSocket.html#SendString^^Send data string via connected socket. Any terminator is not added! If you need send true string with CR-LF termination, you must add CR-LF characters to sended string! Because any termination is not added automaticly, you can use this function for sending any binary data in binary string. ^0" +s[49] = "blcksock.TBlockSocket.SendInteger^blcksock.TBlockSocket.html#SendInteger^^Send integer as four bytes to socket. ^0" +s[50] = "blcksock.TBlockSocket.SendBlock^blcksock.TBlockSocket.html#SendBlock^^Send data as one block to socket. Each block begin with 4 bytes with length of data in block. This 4 bytes is added automaticly by this function. ^0" +s[51] = "blcksock.TBlockSocket.SendStreamRaw^blcksock.TBlockSocket.html#SendStreamRaw^^Send data from stream to socket. ^0" +s[52] = "blcksock.TBlockSocket.SendStream^blcksock.TBlockSocket.html#SendStream^^Send content of stream to socket. It using SendBlock method ^0" +s[53] = "blcksock.TBlockSocket.SendStreamIndy^blcksock.TBlockSocket.html#SendStreamIndy^^Send content of stream to socket. It using SendBlock method and this is compatible with streams in Indy library. ^0" +s[54] = "blcksock.TBlockSocket.RecvBuffer^blcksock.TBlockSocket.html#RecvBuffer^^Note: This is low-level receive function. You must be sure if data is waiting for read before call this function for avoid deadlock!

On stream oriented sockets if is received 0 bytes, it mean 'socket is closed!"

On datagram socket is readed first waiting datagram. ^0" +s[55] = "blcksock.TBlockSocket.RecvBufferEx^blcksock.TBlockSocket.html#RecvBufferEx^^Note: This is high-level receive function. It using internal LineBuffer and you can combine this function freely with other high-level functions!

Method waits until data is received. If no data is received within TIMEOUT (in milliseconds) period, LastError is set to WSAETIMEDOUT. Methods serves for reading any size of data (i.e. one megabyte...). This method is preffered for reading from stream sockets (like TCP). ^0" +s[56] = "blcksock.TBlockSocket.RecvBufferStr^blcksock.TBlockSocket.html#RecvBufferStr^^Similar to RecvBufferEx, but readed data is stored in binary string, not in memory buffer. ^0" +s[57] = "blcksock.TBlockSocket.RecvByte^blcksock.TBlockSocket.html#RecvByte^^Note: This is high-level receive function. It using internal LineBuffer and you can combine this function freely with other high-level functions.

Waits until one data byte is received which is also returned as function result. If no data is received within TIMEOUT (in milliseconds)period, LastError is set to WSAETIMEDOUT and result have value 0. ^0" +s[58] = "blcksock.TBlockSocket.RecvInteger^blcksock.TBlockSocket.html#RecvInteger^^Note: This is high-level receive function. It using internal LineBuffer and you can combine this function freely with other high-level functions.

Waits until one four bytes are received and return it as one Ineger Value. If no data is received within TIMEOUT (in milliseconds)period, LastError is set to WSAETIMEDOUT and result have value 0. ^0" +s[59] = "blcksock.TBlockSocket.RecvString^blcksock.TBlockSocket.html#RecvString^^Note: This is high-level receive function. It using internal LineBuffer and you can combine this function freely with other high-level functions.

Method waits until data string is received. This string is terminated by CR-LF characters. The resulting string is returned without this termination (CR-LF)! If ConvertLineEnd is used, then CR-LF sequence may not be exactly CR-LF. See ConvertLineEnd description. If no data is received within TIMEOUT (in milliseconds) period, LastError is set to WSAETIMEDOUT. You may also specify maximum length of reading data by MaxLineLength property. ^0" +s[60] = "blcksock.TBlockSocket.RecvTerminated^blcksock.TBlockSocket.html#RecvTerminated^^Note: This is high-level receive function. It using internal LineBuffer and you can combine this function freely with other high-level functions.

Method waits until data string is received. This string is terminated by Terminator string. The resulting string is returned without this termination. If no data is received within TIMEOUT (in milliseconds) period, LastError is set to WSAETIMEDOUT. You may also specify maximum length of reading data by MaxLineLength property. ^0" +s[61] = "blcksock.TBlockSocket.RecvPacket^blcksock.TBlockSocket.html#RecvPacket^^Note: This is high-level receive function. It using internal LineBuffer and you can combine this function freely with other high-level functions.

Method reads all data waiting for read. If no data is received within TIMEOUT (in milliseconds) period, LastError is set to WSAETIMEDOUT. Methods serves for reading unknown size of data. Because before call this function you don't know size of received data, returned data is stored in dynamic size binary string. This method is preffered for reading from stream sockets (like TCP). It is very goot for receiving datagrams too! (UDP protocol) ^0" +s[62] = "blcksock.TBlockSocket.RecvBlock^blcksock.TBlockSocket.html#RecvBlock^^Read one block of data from socket. Each block begin with 4 bytes with length of data in block. This function read first 4 bytes for get lenght, then it wait for reported count of bytes. ^0" +s[63] = "blcksock.TBlockSocket.RecvStreamRaw^blcksock.TBlockSocket.html#RecvStreamRaw^^Read all data from socket to stream until socket is closed (or any error occured.) ^0" +s[64] = "blcksock.TBlockSocket.RecvStreamSize^blcksock.TBlockSocket.html#RecvStreamSize^^Read requested count of bytes from socket to stream. ^0" +s[65] = "blcksock.TBlockSocket.RecvStream^blcksock.TBlockSocket.html#RecvStream^^Receive data to stream. It using RecvBlock method. ^0" +s[66] = "blcksock.TBlockSocket.RecvStreamIndy^blcksock.TBlockSocket.html#RecvStreamIndy^^Receive data to stream. This function is compatible with similar function in Indy library. It using RecvBlock method. ^0" +s[67] = "blcksock.TBlockSocket.PeekBuffer^blcksock.TBlockSocket.html#PeekBuffer^^Same as RecvBuffer, but readed data stays in system input buffer. Warning: this function not respect data in LineBuffer! Is not recommended to use this function! ^0" +s[68] = "blcksock.TBlockSocket.PeekByte^blcksock.TBlockSocket.html#PeekByte^^Same as RecvByte, but readed data stays in input system buffer. Warning: this function not respect data in LineBuffer! Is not recommended to use this function! ^0" +s[69] = "blcksock.TBlockSocket.WaitingData^blcksock.TBlockSocket.html#WaitingData^^On stream sockets it returns number of received bytes waiting for picking. 0 is returned when there is no such data. On datagram socket it returns length of the first waiting datagram. Returns 0 if no datagram is waiting. ^0" +s[70] = "blcksock.TBlockSocket.WaitingDataEx^blcksock.TBlockSocket.html#WaitingDataEx^^Same as WaitingData, but if exists some of data in LineBuffer, return their length instead. ^0" +s[71] = "blcksock.TBlockSocket.Purge^blcksock.TBlockSocket.html#Purge^^Clear all waiting data for read from buffers. ^0" +s[72] = "blcksock.TBlockSocket.SetLinger^blcksock.TBlockSocket.html#SetLinger^^Sets linger. Enabled linger means that the system waits another LINGER (in milliseconds) time for delivery of sent data. This function is only for stream type of socket! (TCP) ^0" +s[73] = "blcksock.TBlockSocket.GetSinLocal^blcksock.TBlockSocket.html#GetSinLocal^^Actualize values in LocalSin. ^0" +s[74] = "blcksock.TBlockSocket.GetSinRemote^blcksock.TBlockSocket.html#GetSinRemote^^Actualize values in RemoteSin. ^0" +s[75] = "blcksock.TBlockSocket.GetSins^blcksock.TBlockSocket.html#GetSins^^Actualize values in LocalSin and RemoteSin. ^0" +s[76] = "blcksock.TBlockSocket.ResetLastError^blcksock.TBlockSocket.html#ResetLastError^^Reset LastError and LastErrorDesc to non-error state. ^0" +s[77] = "blcksock.TBlockSocket.SockCheck^blcksock.TBlockSocket.html#SockCheck^^If you "manually" call Socket API functions, forward their return code as parameter to this function, which evaluates it, eventually calls GetLastError and found error code returns and stores to LastError. ^0" +s[78] = "blcksock.TBlockSocket.ExceptCheck^blcksock.TBlockSocket.html#ExceptCheck^^If LastError contains some error code and RaiseExcept property is True, raise adequate exception. ^0" +s[79] = "blcksock.TBlockSocket.LocalName^blcksock.TBlockSocket.html#LocalName^^Returns local computer name as numerical or symbolic value. It try get fully qualified domain name. Name is returned in the format acceptable by functions demanding IP as input parameter. ^0" +s[80] = "blcksock.TBlockSocket.ResolveNameToIP^blcksock.TBlockSocket.html#ResolveNameToIP^^Try resolve name to all possible IP address. i.e. If you pass as name result of LocalName method, you get all IP addresses used by local system. ^0" +s[81] = "blcksock.TBlockSocket.ResolveName^blcksock.TBlockSocket.html#ResolveName^^Try resolve name to primary IP address. i.e. If you pass as name result of LocalName method, you get primary IP addresses used by local system. ^0" +s[82] = "blcksock.TBlockSocket.ResolveIPToName^blcksock.TBlockSocket.html#ResolveIPToName^^Try resolve IP to their primary domain name. If IP not have domain name, then is returned original IP. ^0" +s[83] = "blcksock.TBlockSocket.ResolvePort^blcksock.TBlockSocket.html#ResolvePort^^Try resolve symbolic port name to port number. (i.e. 'Echo' to 8) ^0" +s[84] = "blcksock.TBlockSocket.SetRemoteSin^blcksock.TBlockSocket.html#SetRemoteSin^^Set information about remote side socket. It is good for seting remote side for sending UDP packet, etc. ^0" +s[85] = "blcksock.TBlockSocket.GetLocalSinIP^blcksock.TBlockSocket.html#GetLocalSinIP^^Picks IP socket address from LocalSin. ^0" +s[86] = "blcksock.TBlockSocket.GetRemoteSinIP^blcksock.TBlockSocket.html#GetRemoteSinIP^^Picks IP socket address from RemoteSin. ^0" +s[87] = "blcksock.TBlockSocket.GetLocalSinPort^blcksock.TBlockSocket.html#GetLocalSinPort^^Picks socket PORT number from LocalSin. ^0" +s[88] = "blcksock.TBlockSocket.GetRemoteSinPort^blcksock.TBlockSocket.html#GetRemoteSinPort^^Picks socket PORT number from RemoteSin. ^0" +s[89] = "blcksock.TBlockSocket.CanRead^blcksock.TBlockSocket.html#CanRead^^Return True, if you can read any data from socket or is incoming connection on TCP based socket. Status is tested for time Timeout (in milliseconds). If value in Timeout is 0, status is only tested and continue. If value in Timeout is -1, run is breaked and waiting for read data maybe forever.

This function is need only on special cases, when you need use RecvBuffer function directly! read functioms what have timeout as calling parameter, calling this function internally. ^0" +s[90] = "blcksock.TBlockSocket.CanReadEx^blcksock.TBlockSocket.html#CanReadEx^^Same as CanRead, but additionally return True if is some data in LineBuffer. ^0" +s[91] = "blcksock.TBlockSocket.CanWrite^blcksock.TBlockSocket.html#CanWrite^^Return True, if you can to socket write any data (not full sending buffer). Status is tested for time Timeout (in milliseconds). If value in Timeout is 0, status is only tested and continue. If value in Timeout is -1, run is breaked and waiting for write data maybe forever.

This function is need only on special cases! ^0" +s[92] = "blcksock.TBlockSocket.SendBufferTo^blcksock.TBlockSocket.html#SendBufferTo^^Same as SendBuffer, but send datagram to address from RemoteSin. Usefull for sending reply to datagram received by function RecvBufferFrom. ^0" +s[93] = "blcksock.TBlockSocket.RecvBufferFrom^blcksock.TBlockSocket.html#RecvBufferFrom^^Note: This is low-lever receive function. You must be sure if data is waiting for read before call this function for avoid deadlock!

Receives first waiting datagram to allocated buffer. If there is no waiting one, then waits until one comes. Returns length of datagram stored in BUFFER. If length exceeds buffer datagram is truncated. After this RemoteSin structure contains information about sender of UDP packet. ^0" +s[94] = "blcksock.TBlockSocket.GroupCanRead^blcksock.TBlockSocket.html#GroupCanRead^^This function is for check for incoming data on set of sockets. Whitch sockets is checked is decribed by SocketList Tlist with TBlockSocket objects. TList may have maximal number of objects defined by FD_SETSIZE constant. Return True, if you can from some socket read any data or is incoming connection on TCP based socket. Status is tested for time Timeout (in milliseconds). If value in Timeout is 0, status is only tested and continue. If value in Timeout is -1, run is breaked and waiting for read data maybe forever. If is returned True, CanReadList TList is filled by all TBlockSocket objects what waiting for read. ^0" +s[95] = "blcksock.TBlockSocket.EnableReuse^blcksock.TBlockSocket.html#EnableReuse^^By this method you may turn address reuse mode for local Bind. It is good specially for UDP protocol. Using this with TCP protocol is hazardous! ^0" +s[96] = "blcksock.TBlockSocket.SetTimeout^blcksock.TBlockSocket.html#SetTimeout^^Try set timeout for all sending and receiving operations, if socket provider can do it. (It not supported by all socket providers!) ^0" +s[97] = "blcksock.TBlockSocket.SetSendTimeout^blcksock.TBlockSocket.html#SetSendTimeout^^Try set timeout for all sending operations, if socket provider can do it. (It not supported by all socket providers!) ^0" +s[98] = "blcksock.TBlockSocket.SetRecvTimeout^blcksock.TBlockSocket.html#SetRecvTimeout^^Try set timeout for all receiving operations, if socket provider can do it. (It not supported by all socket providers!) ^0" +s[99] = "blcksock.TBlockSocket.GetSocketType^blcksock.TBlockSocket.html#GetSocketType^^Return value of socket type. ^0" +s[100] = "blcksock.TBlockSocket.GetSocketProtocol^blcksock.TBlockSocket.html#GetSocketProtocol^^Return value of protocol type for socket creation. ^0" +s[101] = "blcksock.TBlockSocket.GetErrorDesc^blcksock.TBlockSocket.html#GetErrorDesc^^Return descriptive string for given error code. This is class function. You may call it without created object! ^0" +s[102] = "blcksock.TBlockSocket.GetErrorDescEx^blcksock.TBlockSocket.html#GetErrorDescEx^^Return descriptive string for LastError. ^0" +s[103] = "blcksock.TBlockSocket.WSAData^blcksock.TBlockSocket.html#WSAData^^WSA structure with information about socket provider. On non-windows platforms this structure is simulated! ^0" +s[104] = "blcksock.TBlockSocket.FDset^blcksock.TBlockSocket.html#FDset^^FDset structure prepared for usage with this socket. ^0" +s[105] = "blcksock.TBlockSocket.LocalSin^blcksock.TBlockSocket.html#LocalSin^^Structure describing local socket side. ^0" +s[106] = "blcksock.TBlockSocket.RemoteSin^blcksock.TBlockSocket.html#RemoteSin^^Structure describing remote socket side. ^0" +s[107] = "blcksock.TBlockSocket.Socket^blcksock.TBlockSocket.html#Socket^^Socket handler. Suitable for "manual" calls to socket API or manual connection of socket to a previously created socket (i.e by Accept method on TCP socket) ^0" +s[108] = "blcksock.TBlockSocket.LastError^blcksock.TBlockSocket.html#LastError^^Last socket operation error code. Error codes are described in socket documentation. Human readable error description is stored in LastErrorDesc property. ^0" +s[109] = "blcksock.TBlockSocket.LastErrorDesc^blcksock.TBlockSocket.html#LastErrorDesc^^Human readable error description of LastError code. ^0" +s[110] = "blcksock.TBlockSocket.LineBuffer^blcksock.TBlockSocket.html#LineBuffer^^Buffer used by all high-level receiving functions. This buffer is used for optimized reading of data from socket. In normal cases you not need access to this buffer directly! ^0" +s[111] = "blcksock.TBlockSocket.SizeRecvBuffer^blcksock.TBlockSocket.html#SizeRecvBuffer^^Size of Winsock receive buffer. If it is not supported by socket provider, it return as size one kilobyte. ^0" +s[112] = "blcksock.TBlockSocket.SizeSendBuffer^blcksock.TBlockSocket.html#SizeSendBuffer^^Size of Winsock send buffer. If it is not supported by socket provider, it return as size one kilobyte. ^0" +s[113] = "blcksock.TBlockSocket.NonBlockMode^blcksock.TBlockSocket.html#NonBlockMode^^If True, turn class to non-blocking mode. Not all functions are working properly in this mode, you must know exactly what you are doing! However when you have big experience with non-blocking programming, then you can optimise your program by non-block mode! ^0" +s[114] = "blcksock.TBlockSocket.TTL^blcksock.TBlockSocket.html#TTL^^Set Time-to-live value. (if system supporting it!) ^0" +s[115] = "blcksock.TBlockSocket.IP6used^blcksock.TBlockSocket.html#IP6used^^If is True, then class in in IPv6 mode. ^0" +s[116] = "blcksock.TBlockSocket.RecvCounter^blcksock.TBlockSocket.html#RecvCounter^^Return count of received bytes on this socket from begin of current connection. ^0" +s[117] = "blcksock.TBlockSocket.SendCounter^blcksock.TBlockSocket.html#SendCounter^^Return count of sended bytes on this socket from begin of current connection. ^0" +s[118] = "blcksock.TBlockSocket.Tag^blcksock.TBlockSocket.html#Tag^^this value is for free use. ^0" +s[119] = "blcksock.TBlockSocket.RaiseExcept^blcksock.TBlockSocket.html#RaiseExcept^^If True, winsock errors raises exception. Otherwise is setted LastError value only and you must check it from your program! Default value is False. ^0" +s[120] = "blcksock.TBlockSocket.MaxLineLength^blcksock.TBlockSocket.html#MaxLineLength^^Define maximum length in bytes of LineBuffer for high-level receiving functions. If this functions try to read more data then this limit, error is returned! If value is 0 (default), no limitation is used. This is very good protection for stupid attacks to your server by sending lot of data without proper terminator... until all your memory is allocated by LineBuffer!

Note: This maximum length is checked only in functions, what read unknown number of bytes! (like RecvString or RecvTerminated) ^0" +s[121] = "blcksock.TBlockSocket.MaxSendBandwidth^blcksock.TBlockSocket.html#MaxSendBandwidth^^Define maximal bandwidth for all sending operations in bytes per second. If value is 0 (default), bandwidth limitation is not used. ^0" +s[122] = "blcksock.TBlockSocket.MaxRecvBandwidth^blcksock.TBlockSocket.html#MaxRecvBandwidth^^Define maximal bandwidth for all receiving operations in bytes per second. If value is 0 (default), bandwidth limitation is not used. ^0" +s[123] = "blcksock.TBlockSocket.MaxBandwidth^blcksock.TBlockSocket.html#MaxBandwidth^^Define maximal bandwidth for all sending and receiving operations in bytes per second. If value is 0 (default), bandwidth limitation is not used. ^0" +s[124] = "blcksock.TBlockSocket.ConvertLineEnd^blcksock.TBlockSocket.html#ConvertLineEnd^^Do a conversion of non-standard line terminators to CRLF. (Off by default) If True, then terminators like sigle CR, single LF or LFCR are converted to CRLF internally. This have effect only in RecvString method! ^0" +s[125] = "blcksock.TBlockSocket.Family^blcksock.TBlockSocket.html#Family^^Specified Family of this socket. When you are using Windows preliminary support for IPv6, then I recommend to set this property! ^0" +s[126] = "blcksock.TBlockSocket.PreferIP4^blcksock.TBlockSocket.html#PreferIP4^^When resolving of domain name return both IPv4 and IPv6 addresses, then specify if is used IPv4 (dafault - True) or IPv6. ^0" +s[127] = "blcksock.TBlockSocket.InterPacketTimeout^blcksock.TBlockSocket.html#InterPacketTimeout^^By default (True) is all timeouts used as timeout between two packets in reading operations. If you set this to False, then Timeouts is for overall reading operation! ^0" +s[128] = "blcksock.TBlockSocket.SendMaxChunk^blcksock.TBlockSocket.html#SendMaxChunk^^All sended datas was splitted by this value. ^0" +s[129] = "blcksock.TBlockSocket.StopFlag^blcksock.TBlockSocket.html#StopFlag^^By setting this property to True you can stop any communication. You can use this property for soft abort of communication. ^0" +s[130] = "blcksock.TBlockSocket.NonblockSendTimeout^blcksock.TBlockSocket.html#NonblockSendTimeout^^Timeout for data sending by non-blocking socket mode. ^0" +s[131] = "blcksock.TBlockSocket.OnStatus^blcksock.TBlockSocket.html#OnStatus^^This event is called by various reasons. It is good for monitoring socket, create gauges for data transfers, etc. ^0" +s[132] = "blcksock.TBlockSocket.OnReadFilter^blcksock.TBlockSocket.html#OnReadFilter^^this event is good for some internal thinks about filtering readed datas. It is used by telnet client by example. ^0" +s[133] = "blcksock.TBlockSocket.OnCreateSocket^blcksock.TBlockSocket.html#OnCreateSocket^^This event is called after real socket creation for setting special socket options, because you not know when socket is created. (it is depended on Ipv4, IPv6 or automatic mode) ^0" +s[134] = "blcksock.TBlockSocket.OnMonitor^blcksock.TBlockSocket.html#OnMonitor^^This event is good for monitoring content of readed or writed datas. ^0" +s[135] = "blcksock.TBlockSocket.OnHeartbeat^blcksock.TBlockSocket.html#OnHeartbeat^^This event is good for calling your code during long socket operations. (Example, for refresing UI if class in not called within the thread.) Rate of heartbeats can be modified by HeartbeatRate property. ^0" +s[136] = "blcksock.TBlockSocket.HeartbeatRate^blcksock.TBlockSocket.html#HeartbeatRate^^Specify typical rate of OnHeartbeat event and StopFlag testing. Default value 0 disabling heartbeats! Value is in milliseconds. Real rate can be higher or smaller then this value, because it depending on real socket operations too! Note: Each heartbeat slowing socket processing. ^0" +s[137] = "blcksock.TBlockSocket.Owner^blcksock.TBlockSocket.html#Owner^^What class own this socket? Used by protocol implementation classes. ^0" +s[138] = "blcksock.TSocksBlockSocket^blcksock.TSocksBlockSocket.html^Support for SOCKS4 and SOCKS5 proxy^ Layer with definition all necessary properties and functions for implementation SOCKS proxy client. Do not use this class directly. ^0" +s[139] = "blcksock.TSocksBlockSocket.Create^blcksock.TSocksBlockSocket.html#Create^^ ^0" +s[140] = "blcksock.TSocksBlockSocket.SocksOpen^blcksock.TSocksBlockSocket.html#SocksOpen^^Open connection to SOCKS proxy and if SocksUsername is set, do authorisation to proxy. This is needed only in special cases! (it is called internally!) ^0" +s[141] = "blcksock.TSocksBlockSocket.SocksRequest^blcksock.TSocksBlockSocket.html#SocksRequest^^Send specified request to SOCKS proxy. This is needed only in special cases! (it is called internally!) ^0" +s[142] = "blcksock.TSocksBlockSocket.SocksResponse^blcksock.TSocksBlockSocket.html#SocksResponse^^Receive response to previosly sended request. This is needed only in special cases! (it is called internally!) ^0" +s[143] = "blcksock.TSocksBlockSocket.UsingSocks^blcksock.TSocksBlockSocket.html#UsingSocks^^Is True when class is using SOCKS proxy. ^0" +s[144] = "blcksock.TSocksBlockSocket.SocksLastError^blcksock.TSocksBlockSocket.html#SocksLastError^^If SOCKS proxy failed, here is error code returned from SOCKS proxy. ^0" +s[145] = "blcksock.TSocksBlockSocket.SocksIP^blcksock.TSocksBlockSocket.html#SocksIP^^Address of SOCKS server. If value is empty string, SOCKS support is disabled. Assingning any value to this property enable SOCKS mode. Warning: You cannot combine this mode with HTTP-tunneling mode! ^0" +s[146] = "blcksock.TSocksBlockSocket.SocksPort^blcksock.TSocksBlockSocket.html#SocksPort^^Port of SOCKS server. Default value is '1080'. ^0" +s[147] = "blcksock.TSocksBlockSocket.SocksUsername^blcksock.TSocksBlockSocket.html#SocksUsername^^If you need authorisation on SOCKS server, set username here. ^0" +s[148] = "blcksock.TSocksBlockSocket.SocksPassword^blcksock.TSocksBlockSocket.html#SocksPassword^^If you need authorisation on SOCKS server, set password here. ^0" +s[149] = "blcksock.TSocksBlockSocket.SocksTimeout^blcksock.TSocksBlockSocket.html#SocksTimeout^^Specify timeout for communicatin with SOCKS server. Default is one minute. ^0" +s[150] = "blcksock.TSocksBlockSocket.SocksResolver^blcksock.TSocksBlockSocket.html#SocksResolver^^If True, all symbolic names of target hosts is not translated to IP's locally, but resolving is by SOCKS proxy. Default is True. ^0" +s[151] = "blcksock.TSocksBlockSocket.SocksType^blcksock.TSocksBlockSocket.html#SocksType^^Specify SOCKS type. By default is used SOCKS5, but you can use SOCKS4 too. When you select SOCKS4, then if SocksResolver is enabled, then is used SOCKS4a. Othervise is used pure SOCKS4. ^0" +s[152] = "blcksock.TTCPBlockSocket^blcksock.TTCPBlockSocket.html^Implementation of TCP socket.^ Supported features: IPv4, IPv6, SSL/TLS or SSH (depending on used plugin), SOCKS5 proxy (outgoing connections and limited incomming), SOCKS4/4a proxy (outgoing connections and limited incomming), TCP through HTTP proxy tunnel. ^0" +s[153] = "blcksock.TTCPBlockSocket.Create^blcksock.TTCPBlockSocket.html#Create^^Create TCP socket class with default plugin for SSL/TSL/SSH implementation (see SSLImplementation) ^0" +s[154] = "blcksock.TTCPBlockSocket.CreateWithSSL^blcksock.TTCPBlockSocket.html#CreateWithSSL^^Create TCP socket class with desired plugin for SSL/TSL/SSH implementation ^0" +s[155] = "blcksock.TTCPBlockSocket.Destroy^blcksock.TTCPBlockSocket.html#Destroy^^ ^0" +s[156] = "blcksock.TTCPBlockSocket.CloseSocket^blcksock.TTCPBlockSocket.html#CloseSocket^^See TBlockSocket.CloseSocket ^0" +s[157] = "blcksock.TTCPBlockSocket.WaitingData^blcksock.TTCPBlockSocket.html#WaitingData^^See TBlockSocket.WaitingData ^0" +s[158] = "blcksock.TTCPBlockSocket.Listen^blcksock.TTCPBlockSocket.html#Listen^^Sets socket to receive mode for new incoming connections. It is necessary to use TBlockSocket.Bind function call before this method to select receiving port!

If you use SOCKS, activate incoming TCP connection by this proxy. (By BIND method of SOCKS.) ^0" +s[159] = "blcksock.TTCPBlockSocket.Accept^blcksock.TTCPBlockSocket.html#Accept^^Waits until new incoming connection comes. After it comes a new socket is automatically created (socket handler is returned by this function as result).

If you use SOCKS, new socket is not created! In this case is used same socket as socket for listening! So, you can accept only one connection in SOCKS mode. ^0" +s[160] = "blcksock.TTCPBlockSocket.Connect^blcksock.TTCPBlockSocket.html#Connect^^Connects socket to remote IP address and PORT. The same rules as with TBlockSocket.Bind method are valid. The only exception is that PORT with 0 value will not be connected. After call to this method a communication channel between local and remote socket is created. Local socket is assigned automatically if not controlled by previous call to TBlockSocket.Bind method. Structures TBlockSocket.LocalSin and TBlockSocket.RemoteSin will be filled with valid values.

If you use SOCKS, activate outgoing TCP connection by SOCKS proxy specified in TSocksBlockSocket.SocksIP. (By CONNECT method of SOCKS.)

If you use HTTP-tunnel mode, activate outgoing TCP connection by HTTP tunnel specified in HTTPTunnelIP. (By CONNECT method of HTTP protocol.)

Note: If you call this on non-created socket, then socket is created automaticly. ^0" +s[161] = "blcksock.TTCPBlockSocket.SSLDoConnect^blcksock.TTCPBlockSocket.html#SSLDoConnect^^If you need upgrade existing TCP connection to SSL/TLS (or SSH2, if plugin allows it) mode, then call this method. This method switch this class to SSL mode and do SSL/TSL handshake. ^0" +s[162] = "blcksock.TTCPBlockSocket.SSLDoShutdown^blcksock.TTCPBlockSocket.html#SSLDoShutdown^^By this method you can downgrade existing SSL/TLS connection to normal TCP connection. ^0" +s[163] = "blcksock.TTCPBlockSocket.SSLAcceptConnection^blcksock.TTCPBlockSocket.html#SSLAcceptConnection^^If you need use this component as SSL/TLS TCP server, then after accepting of inbound connection you need start SSL/TLS session by this method. Before call this function, you must have assigned all neeeded certificates and keys! ^0" +s[164] = "blcksock.TTCPBlockSocket.GetLocalSinIP^blcksock.TTCPBlockSocket.html#GetLocalSinIP^^See TBlockSocket.GetLocalSinIP ^0" +s[165] = "blcksock.TTCPBlockSocket.GetRemoteSinIP^blcksock.TTCPBlockSocket.html#GetRemoteSinIP^^See TBlockSocket.GetRemoteSinIP ^0" +s[166] = "blcksock.TTCPBlockSocket.GetLocalSinPort^blcksock.TTCPBlockSocket.html#GetLocalSinPort^^See TBlockSocket.GetLocalSinPort ^0" +s[167] = "blcksock.TTCPBlockSocket.GetRemoteSinPort^blcksock.TTCPBlockSocket.html#GetRemoteSinPort^^See TBlockSocket.GetRemoteSinPort ^0" +s[168] = "blcksock.TTCPBlockSocket.SendBuffer^blcksock.TTCPBlockSocket.html#SendBuffer^^See TBlockSocket.SendBuffer ^0" +s[169] = "blcksock.TTCPBlockSocket.RecvBuffer^blcksock.TTCPBlockSocket.html#RecvBuffer^^See TBlockSocket.RecvBuffer ^0" +s[170] = "blcksock.TTCPBlockSocket.GetSocketType^blcksock.TTCPBlockSocket.html#GetSocketType^^Return value of socket type. For TCP return SOCK_STREAM. ^0" +s[171] = "blcksock.TTCPBlockSocket.GetSocketProtocol^blcksock.TTCPBlockSocket.html#GetSocketProtocol^^Return value of protocol type for socket creation. For TCP return IPPROTO_TCP. ^0" +s[172] = "blcksock.TTCPBlockSocket.GetErrorDescEx^blcksock.TTCPBlockSocket.html#GetErrorDescEx^^Return descriptive string for LastError. On case of error in SSL/TLS subsystem, it returns right error description. ^0" +s[173] = "blcksock.TTCPBlockSocket.SSL^blcksock.TTCPBlockSocket.html#SSL^^Class implementing SSL/TLS support. It is allways some descendant of TCustomSSL class. When programmer not select some SSL plugin class, then is used TSSLNone ^0" +s[174] = "blcksock.TTCPBlockSocket.HTTPTunnel^blcksock.TTCPBlockSocket.html#HTTPTunnel^^True if is used HTTP tunnel mode. ^0" +s[175] = "blcksock.TTCPBlockSocket.HTTPTunnelIP^blcksock.TTCPBlockSocket.html#HTTPTunnelIP^^Specify IP address of HTTP proxy. Assingning non-empty value to this property enable HTTP-tunnel mode. This mode is for tunnelling any outgoing TCP connection through HTTP proxy server. (If policy on HTTP proxy server allow this!) Warning: You cannot combine this mode with SOCK5 mode! ^0" +s[176] = "blcksock.TTCPBlockSocket.HTTPTunnelPort^blcksock.TTCPBlockSocket.html#HTTPTunnelPort^^Specify port of HTTP proxy for HTTP-tunneling. ^0" +s[177] = "blcksock.TTCPBlockSocket.HTTPTunnelUser^blcksock.TTCPBlockSocket.html#HTTPTunnelUser^^Specify authorisation username for access to HTTP proxy in HTTP-tunnel mode. If you not need authorisation, then let this property empty. ^0" +s[178] = "blcksock.TTCPBlockSocket.HTTPTunnelPass^blcksock.TTCPBlockSocket.html#HTTPTunnelPass^^Specify authorisation password for access to HTTP proxy in HTTP-tunnel mode. ^0" +s[179] = "blcksock.TTCPBlockSocket.HTTPTunnelTimeout^blcksock.TTCPBlockSocket.html#HTTPTunnelTimeout^^Specify timeout for communication with HTTP proxy in HTTPtunnel mode. ^0" +s[180] = "blcksock.TTCPBlockSocket.OnAfterConnect^blcksock.TTCPBlockSocket.html#OnAfterConnect^^This event is called after sucessful TCP socket connection. ^0" +s[181] = "blcksock.TDgramBlockSocket^blcksock.TDgramBlockSocket.html^Datagram based communication^ This class implementing datagram based communication instead default stream based communication style. ^0" +s[182] = "blcksock.TDgramBlockSocket.Connect^blcksock.TDgramBlockSocket.html#Connect^^Fill TBlockSocket.RemoteSin structure. This address is used for sending data. ^0" +s[183] = "blcksock.TDgramBlockSocket.SendBuffer^blcksock.TDgramBlockSocket.html#SendBuffer^^Silently redirected to TBlockSocket.SendBufferTo. ^0" +s[184] = "blcksock.TDgramBlockSocket.RecvBuffer^blcksock.TDgramBlockSocket.html#RecvBuffer^^Silently redirected to TBlockSocket.RecvBufferFrom. ^0" +s[185] = "blcksock.TUDPBlockSocket^blcksock.TUDPBlockSocket.html^Implementation of UDP socket.^ NOTE: in this class is all receiving redirected to RecvBufferFrom. You can use for reading any receive function. Preffered is RecvPacket! Similary all sending is redirected to SendbufferTo. You can use for sending UDP packet any sending function, like SendString.

Supported features: IPv4, IPv6, unicasts, broadcasts, multicasts, SOCKS5 proxy (only unicasts! Outgoing and incomming.) ^0" +s[186] = "blcksock.TUDPBlockSocket.Destroy^blcksock.TUDPBlockSocket.html#Destroy^^ ^0" +s[187] = "blcksock.TUDPBlockSocket.EnableBroadcast^blcksock.TUDPBlockSocket.html#EnableBroadcast^^Enable or disable sending of broadcasts. If seting OK, result is True. This method is not supported in SOCKS5 mode! IPv6 does not support broadcasts! In this case you must use Multicasts instead. ^0" +s[188] = "blcksock.TUDPBlockSocket.SendBufferTo^blcksock.TUDPBlockSocket.html#SendBufferTo^^See TBlockSocket.SendBufferTo ^0" +s[189] = "blcksock.TUDPBlockSocket.RecvBufferFrom^blcksock.TUDPBlockSocket.html#RecvBufferFrom^^See TBlockSocket.RecvBufferFrom ^0" +s[190] = "blcksock.TUDPBlockSocket.AddMulticast^blcksock.TUDPBlockSocket.html#AddMulticast^^Add this socket to given multicast group. You cannot use Multicasts in SOCKS mode! ^0" +s[191] = "blcksock.TUDPBlockSocket.DropMulticast^blcksock.TUDPBlockSocket.html#DropMulticast^^Remove this socket from given multicast group. ^0" +s[192] = "blcksock.TUDPBlockSocket.EnableMulticastLoop^blcksock.TUDPBlockSocket.html#EnableMulticastLoop^^All sended multicast datagrams is loopbacked to your interface too. (you can read your sended datas.) You can disable this feature by this function. This function not working on some Windows systems! ^0" +s[193] = "blcksock.TUDPBlockSocket.GetSocketType^blcksock.TUDPBlockSocket.html#GetSocketType^^Return value of socket type. For UDP return SOCK_DGRAM. ^0" +s[194] = "blcksock.TUDPBlockSocket.GetSocketProtocol^blcksock.TUDPBlockSocket.html#GetSocketProtocol^^Return value of protocol type for socket creation. For UDP return IPPROTO_UDP. ^0" +s[195] = "blcksock.TUDPBlockSocket.MulticastTTL^blcksock.TUDPBlockSocket.html#MulticastTTL^^Set Time-to-live value for multicasts packets. It define number of routers for transfer of datas. If you set this to 1 (dafault system value), then multicasts packet goes only to you local network. If you need transport multicast packet to worldwide, then increase this value, but be carefull, lot of routers on internet does not transport multicasts packets! ^0" +s[196] = "blcksock.TICMPBlockSocket^blcksock.TICMPBlockSocket.html^Implementation of RAW ICMP socket.^ For this object you must have rights for creating RAW sockets! ^0" +s[197] = "blcksock.TICMPBlockSocket.GetSocketType^blcksock.TICMPBlockSocket.html#GetSocketType^^Return value of socket type. For RAW and ICMP return SOCK_RAW. ^0" +s[198] = "blcksock.TICMPBlockSocket.GetSocketProtocol^blcksock.TICMPBlockSocket.html#GetSocketProtocol^^Return value of protocol type for socket creation. For ICMP returns IPPROTO_ICMP or IPPROTO_ICMPV6 ^0" +s[199] = "blcksock.TRAWBlockSocket^blcksock.TRAWBlockSocket.html^Implementation of RAW socket.^ For this object you must have rights for creating RAW sockets! ^0" +s[200] = "blcksock.TRAWBlockSocket.GetSocketType^blcksock.TRAWBlockSocket.html#GetSocketType^^Return value of socket type. For RAW and ICMP return SOCK_RAW. ^0" +s[201] = "blcksock.TRAWBlockSocket.GetSocketProtocol^blcksock.TRAWBlockSocket.html#GetSocketProtocol^^Return value of protocol type for socket creation. For RAW returns IPPROTO_RAW. ^0" +s[202] = "blcksock.TPGMMessageBlockSocket^blcksock.TPGMMessageBlockSocket.html^Implementation of PGM-message socket.^ Not all systems supports this protocol! ^0" +s[203] = "blcksock.TPGMMessageBlockSocket.GetSocketType^blcksock.TPGMMessageBlockSocket.html#GetSocketType^^Return value of socket type. For PGM-message return SOCK_RDM. ^0" +s[204] = "blcksock.TPGMMessageBlockSocket.GetSocketProtocol^blcksock.TPGMMessageBlockSocket.html#GetSocketProtocol^^Return value of protocol type for socket creation. For PGM-message returns IPPROTO_RM. ^0" +s[205] = "blcksock.TPGMStreamBlockSocket^blcksock.TPGMStreamBlockSocket.html^Implementation of PGM-stream socket.^ Not all systems supports this protocol! ^0" +s[206] = "blcksock.TPGMStreamBlockSocket.GetSocketType^blcksock.TPGMStreamBlockSocket.html#GetSocketType^^Return value of socket type. For PGM-stream return SOCK_STREAM. ^0" +s[207] = "blcksock.TPGMStreamBlockSocket.GetSocketProtocol^blcksock.TPGMStreamBlockSocket.html#GetSocketProtocol^^Return value of protocol type for socket creation. For PGM-stream returns IPPROTO_RM. ^0" +s[208] = "blcksock.TCustomSSL^blcksock.TCustomSSL.html^Parent class for all SSL plugins.^ This is abstract class defining interface for other SSL plugins.

Instance of this class will be created for each TTCPBlockSocket.

Warning: not all methods and propertis can work in all existing SSL plugins! Please, read documentation of used SSL plugin. ^0" +s[209] = "blcksock.TCustomSSL.Create^blcksock.TCustomSSL.html#Create^^Create plugin class. it is called internally from TTCPBlockSocket ^0" +s[210] = "blcksock.TCustomSSL.Assign^blcksock.TCustomSSL.html#Assign^^Assign settings (certificates and configuration) from another SSL plugin class. ^0" +s[211] = "blcksock.TCustomSSL.LibVersion^blcksock.TCustomSSL.html#LibVersion^^return description of used plugin. It usually return name and version of used SSL library. ^0" +s[212] = "blcksock.TCustomSSL.LibName^blcksock.TCustomSSL.html#LibName^^return name of used plugin. ^0" +s[213] = "blcksock.TCustomSSL.Connect^blcksock.TCustomSSL.html#Connect^^Do not call this directly. It is used internally by TTCPBlockSocket!

Here is needed code for start SSL connection. ^0" +s[214] = "blcksock.TCustomSSL.Accept^blcksock.TCustomSSL.html#Accept^^Do not call this directly. It is used internally by TTCPBlockSocket!

Here is needed code for acept new SSL connection. ^0" +s[215] = "blcksock.TCustomSSL.Shutdown^blcksock.TCustomSSL.html#Shutdown^^Do not call this directly. It is used internally by TTCPBlockSocket!

Here is needed code for hard shutdown of SSL connection. (for example, before socket is closed) ^0" +s[216] = "blcksock.TCustomSSL.BiShutdown^blcksock.TCustomSSL.html#BiShutdown^^Do not call this directly. It is used internally by TTCPBlockSocket!

Here is needed code for soft shutdown of SSL connection. (for example, when you need to continue with unprotected connection.) ^0" +s[217] = "blcksock.TCustomSSL.SendBuffer^blcksock.TCustomSSL.html#SendBuffer^^Do not call this directly. It is used internally by TTCPBlockSocket!

Here is needed code for sending some datas by SSL connection. ^0" +s[218] = "blcksock.TCustomSSL.RecvBuffer^blcksock.TCustomSSL.html#RecvBuffer^^Do not call this directly. It is used internally by TTCPBlockSocket!

Here is needed code for receiving some datas by SSL connection. ^0" +s[219] = "blcksock.TCustomSSL.WaitingData^blcksock.TCustomSSL.html#WaitingData^^Do not call this directly. It is used internally by TTCPBlockSocket!

Here is needed code for getting count of datas what waiting for read. If SSL plugin not allows this, then it should return 0. ^0" +s[220] = "blcksock.TCustomSSL.GetSSLVersion^blcksock.TCustomSSL.html#GetSSLVersion^^Return string with identificator of SSL/TLS version of existing connection. ^0" +s[221] = "blcksock.TCustomSSL.GetPeerSubject^blcksock.TCustomSSL.html#GetPeerSubject^^Return subject of remote SSL peer. ^0" +s[222] = "blcksock.TCustomSSL.GetPeerSerialNo^blcksock.TCustomSSL.html#GetPeerSerialNo^^Return Serial number if remote X509 certificate. ^0" +s[223] = "blcksock.TCustomSSL.GetPeerIssuer^blcksock.TCustomSSL.html#GetPeerIssuer^^Return issuer certificate of remote SSL peer. ^0" +s[224] = "blcksock.TCustomSSL.GetPeerName^blcksock.TCustomSSL.html#GetPeerName^^Return peer name from remote side certificate. This is good for verify, if certificate is generated for remote side IP name. ^0" +s[225] = "blcksock.TCustomSSL.GetPeerNameHash^blcksock.TCustomSSL.html#GetPeerNameHash^^Returns has of peer name from remote side certificate. This is good for fast remote side authentication. ^0" +s[226] = "blcksock.TCustomSSL.GetPeerFingerprint^blcksock.TCustomSSL.html#GetPeerFingerprint^^Return fingerprint of remote SSL peer. ^0" +s[227] = "blcksock.TCustomSSL.GetCertInfo^blcksock.TCustomSSL.html#GetCertInfo^^Return all detailed information about certificate from remote side of SSL/TLS connection. Result string can be multilined! Each plugin can return this informations in different format! ^0" +s[228] = "blcksock.TCustomSSL.GetCipherName^blcksock.TCustomSSL.html#GetCipherName^^Return currently used Cipher. ^0" +s[229] = "blcksock.TCustomSSL.GetCipherBits^blcksock.TCustomSSL.html#GetCipherBits^^Return currently used number of bits in current Cipher algorythm. ^0" +s[230] = "blcksock.TCustomSSL.GetCipherAlgBits^blcksock.TCustomSSL.html#GetCipherAlgBits^^Return number of bits in current Cipher algorythm. ^0" +s[231] = "blcksock.TCustomSSL.GetVerifyCert^blcksock.TCustomSSL.html#GetVerifyCert^^Return result value of verify remote side certificate. Look to OpenSSL documentation for possible values. For example 0 is successfuly verified certificate, or 18 is self-signed certificate. ^0" +s[232] = "blcksock.TCustomSSL.SSLEnabled^blcksock.TCustomSSL.html#SSLEnabled^^Resurn True if SSL mode is enabled on existing cvonnection. ^0" +s[233] = "blcksock.TCustomSSL.LastError^blcksock.TCustomSSL.html#LastError^^Return error code of last SSL operation. 0 is OK. ^0" +s[234] = "blcksock.TCustomSSL.LastErrorDesc^blcksock.TCustomSSL.html#LastErrorDesc^^Return error description of last SSL operation. ^0" +s[235] = "blcksock.TCustomSSL.SSLType^blcksock.TCustomSSL.html#SSLType^^Here you can specify requested SSL/TLS mode. Default is autodetection, but on some servers autodetection not working properly. In this case you must specify requested SSL/TLS mode by your hand! ^0" +s[236] = "blcksock.TCustomSSL.KeyPassword^blcksock.TCustomSSL.html#KeyPassword^^Password for decrypting of encoded certificate or key. ^0" +s[237] = "blcksock.TCustomSSL.Username^blcksock.TCustomSSL.html#Username^^Username for possible credentials. ^0" +s[238] = "blcksock.TCustomSSL.Password^blcksock.TCustomSSL.html#Password^^password for possible credentials. ^0" +s[239] = "blcksock.TCustomSSL.Ciphers^blcksock.TCustomSSL.html#Ciphers^^By this property you can modify default set of SSL/TLS ciphers. ^0" +s[240] = "blcksock.TCustomSSL.CertificateFile^blcksock.TCustomSSL.html#CertificateFile^^Used for loading certificate from disk file. See to plugin documentation if this method is supported and how! ^0" +s[241] = "blcksock.TCustomSSL.PrivateKeyFile^blcksock.TCustomSSL.html#PrivateKeyFile^^Used for loading private key from disk file. See to plugin documentation if this method is supported and how! ^0" +s[242] = "blcksock.TCustomSSL.Certificate^blcksock.TCustomSSL.html#Certificate^^Used for loading certificate from binary string. See to plugin documentation if this method is supported and how! ^0" +s[243] = "blcksock.TCustomSSL.PrivateKey^blcksock.TCustomSSL.html#PrivateKey^^Used for loading private key from binary string. See to plugin documentation if this method is supported and how! ^0" +s[244] = "blcksock.TCustomSSL.PFX^blcksock.TCustomSSL.html#PFX^^Used for loading PFX from binary string. See to plugin documentation if this method is supported and how! ^0" +s[245] = "blcksock.TCustomSSL.PFXfile^blcksock.TCustomSSL.html#PFXfile^^Used for loading PFX from disk file. See to plugin documentation if this method is supported and how! ^0" +s[246] = "blcksock.TCustomSSL.TrustCertificateFile^blcksock.TCustomSSL.html#TrustCertificateFile^^Used for loading trusted certificates from disk file. See to plugin documentation if this method is supported and how! ^0" +s[247] = "blcksock.TCustomSSL.TrustCertificate^blcksock.TCustomSSL.html#TrustCertificate^^Used for loading trusted certificates from binary string. See to plugin documentation if this method is supported and how! ^0" +s[248] = "blcksock.TCustomSSL.CertCA^blcksock.TCustomSSL.html#CertCA^^Used for loading CA certificates from binary string. See to plugin documentation if this method is supported and how! ^0" +s[249] = "blcksock.TCustomSSL.CertCAFile^blcksock.TCustomSSL.html#CertCAFile^^Used for loading CA certificates from disk file. See to plugin documentation if this method is supported and how! ^0" +s[250] = "blcksock.TCustomSSL.VerifyCert^blcksock.TCustomSSL.html#VerifyCert^^If True, then is verified client certificate. (it is good for writing SSL/TLS servers.) When you are not server, but you are client, then if this property is True, verify servers certificate. ^0" +s[251] = "blcksock.TCustomSSL.SSHChannelType^blcksock.TCustomSSL.html#SSHChannelType^^channel type for possible SSH connections ^0" +s[252] = "blcksock.TCustomSSL.SSHChannelArg1^blcksock.TCustomSSL.html#SSHChannelArg1^^First argument of channel type for possible SSH connections ^0" +s[253] = "blcksock.TCustomSSL.SSHChannelArg2^blcksock.TCustomSSL.html#SSHChannelArg2^^Second argument of channel type for possible SSH connections ^0" +s[254] = "blcksock.TCustomSSL.CertComplianceLevel^blcksock.TCustomSSL.html#CertComplianceLevel^^Level of standards compliance level (CryptLib: values in cryptlib.pas, -1: use default value ) ^0" +s[255] = "blcksock.TCustomSSL.OnVerifyCert^blcksock.TCustomSSL.html#OnVerifyCert^^This event is called when verifying the server certificate immediatally after a successfull verification in the ssl library. ^0" +s[256] = "blcksock.TCustomSSL.SNIHost^blcksock.TCustomSSL.html#SNIHost^^Server Name Identification. Host name to send to server. If empty the host name found in URL will be used, which should be the normal use (http Header Host = SNI Host). The value is cleared after the connection is established. (SNI support requires OpenSSL 0.9.8k or later. Cryptlib not supported, yet ) ^0" +s[257] = "blcksock.TSSLNone^blcksock.TSSLNone.html^Default SSL plugin with no SSL support.^ Dummy SSL plugin implementation for applications without SSL/TLS support. ^0" +s[258] = "blcksock.TSSLNone.LibVersion^blcksock.TSSLNone.html#LibVersion^^See TCustomSSL.LibVersion ^0" +s[259] = "blcksock.TSSLNone.LibName^blcksock.TSSLNone.html#LibName^^See TCustomSSL.LibName ^0" +s[260] = "blcksock.TIPHeader^blcksock.TIPHeader.html^Record with definition of IP packet header.^ For reading data from ICMP or RAW sockets. ^0" +s[261] = "blcksock.TIPHeader.VerLen^blcksock.TIPHeader.html#VerLen^^ ^0" +s[262] = "blcksock.TIPHeader.TOS^blcksock.TIPHeader.html#TOS^^ ^0" +s[263] = "blcksock.TIPHeader.TotalLen^blcksock.TIPHeader.html#TotalLen^^ ^0" +s[264] = "blcksock.TIPHeader.Identifer^blcksock.TIPHeader.html#Identifer^^ ^0" +s[265] = "blcksock.TIPHeader.FragOffsets^blcksock.TIPHeader.html#FragOffsets^^ ^0" +s[266] = "blcksock.TIPHeader.TTL^blcksock.TIPHeader.html#TTL^^ ^0" +s[267] = "blcksock.TIPHeader.Protocol^blcksock.TIPHeader.html#Protocol^^ ^0" +s[268] = "blcksock.TIPHeader.CheckSum^blcksock.TIPHeader.html#CheckSum^^ ^0" +s[269] = "blcksock.TIPHeader.SourceIp^blcksock.TIPHeader.html#SourceIp^^ ^0" +s[270] = "blcksock.TIPHeader.DestIp^blcksock.TIPHeader.html#DestIp^^ ^0" +s[271] = "blcksock.TIPHeader.Options^blcksock.TIPHeader.html#Options^^ ^0" +s[272] = "blcksock.TSynaClient^blcksock.TSynaClient.html^Parent class of application protocol implementations.^ By this class is defined common properties. ^0" +s[273] = "blcksock.TSynaClient.Create^blcksock.TSynaClient.html#Create^^ ^0" +s[274] = "blcksock.TSynaClient.TargetHost^blcksock.TSynaClient.html#TargetHost^^Specify terget server IP (or symbolic name). Default is 'localhost'. ^0" +s[275] = "blcksock.TSynaClient.TargetPort^blcksock.TSynaClient.html#TargetPort^^Specify terget server port (or symbolic name). ^0" +s[276] = "blcksock.TSynaClient.IPInterface^blcksock.TSynaClient.html#IPInterface^^Defined local socket address. (outgoing IP address). By default is used '0.0.0.0' as wildcard for default IP. ^0" +s[277] = "blcksock.TSynaClient.Timeout^blcksock.TSynaClient.html#Timeout^^Specify default timeout for socket operations. ^0" +s[278] = "blcksock.TSynaClient.UserName^blcksock.TSynaClient.html#UserName^^If protocol need user authorization, then fill here username. ^0" +s[279] = "blcksock.TSynaClient.Password^blcksock.TSynaClient.html#Password^^If protocol need user authorization, then fill here password. ^0" +s[280] = "blcksock.SynapseRelease^blcksock.html#SynapseRelease^^ ^0" +s[281] = "blcksock.cLocalhost^blcksock.html#cLocalhost^^ ^0" +s[282] = "blcksock.cAnyHost^blcksock.html#cAnyHost^^ ^0" +s[283] = "blcksock.cBroadcast^blcksock.html#cBroadcast^^ ^0" +s[284] = "blcksock.c6Localhost^blcksock.html#c6Localhost^^ ^0" +s[285] = "blcksock.c6AnyHost^blcksock.html#c6AnyHost^^ ^0" +s[286] = "blcksock.c6Broadcast^blcksock.html#c6Broadcast^^ ^0" +s[287] = "blcksock.cAnyPort^blcksock.html#cAnyPort^^ ^0" +s[288] = "blcksock.CR^blcksock.html#CR^^ ^0" +s[289] = "blcksock.LF^blcksock.html#LF^^ ^0" +s[290] = "blcksock.CRLF^blcksock.html#CRLF^^ ^0" +s[291] = "blcksock.c64k^blcksock.html#c64k^^ ^0" +s[292] = "blcksock.THookSocketReason^blcksock.html#THookSocketReason^^Types of OnStatus events HR_ResolvingBegin Resolving is begin. Resolved IP and port is in parameter in format like: 'localhost.somewhere.com:25'. HR_ResolvingEnd Resolving is done. Resolved IP and port is in parameter in format like: 'localhost.somewhere.com:25'. It is always same as in HR_ResolvingBegin! HR_SocketCreate Socket created by CreateSocket method. It reporting Family of created socket too! HR_SocketClose Socket closed by CloseSocket method. HR_Bind Socket binded to IP and Port. Binded IP and Port is in parameter in format like: 'localhost.somewhere.com:25'. HR_Connect Socket connected to IP and Port. Connected IP and Port is in parameter in format like: 'localhost.somewhere.com:25'. HR_CanRead Called when CanRead method is used with True result. HR_CanWrite Called when CanWrite method is used with True result. HR_Listen Socket is swithed to Listen mode. (TCP socket only) HR_Accept Socket Accepting client connection. (TCP socket only) HR_ReadCount report count of bytes readed from socket. Number is in parameter string. If you need is in integer, you must use StrToInt function! HR_WriteCount report count of bytes writed to socket. Number is in parameter string. If you need is in integer, you must use StrToInt function! HR_Wait If is limiting of bandwidth on, then this reason is called when sending or receiving is stopped for satisfy bandwidth limit. Parameter is count of waiting milliseconds. HR_Error report situation where communication error occured. When raiseexcept is True, then exception is called after this Hook reason. ^0" +s[293] = "blcksock.THookSocketStatus^blcksock.html#THookSocketStatus^^Procedural type for OnStatus event. Sender is calling TBlockSocket object, Reason is one of set Status events and value is optional data. ^0" +s[294] = "blcksock.THookDataFilter^blcksock.html#THookDataFilter^^This procedural type is used for DataFilter hooks. ^0" +s[295] = "blcksock.THookCreateSocket^blcksock.html#THookCreateSocket^^This procedural type is used for hook OnCreateSocket. By this hook you can insert your code after initialisation of socket. (you can set special socket options, etc.) ^0" +s[296] = "blcksock.THookMonitor^blcksock.html#THookMonitor^^This procedural type is used for monitoring of communication. ^0" +s[297] = "blcksock.THookAfterConnect^blcksock.html#THookAfterConnect^^This procedural type is used for hook OnAfterConnect. By this hook you can insert your code after TCP socket has been sucessfully connected. ^0" +s[298] = "blcksock.THookVerifyCert^blcksock.html#THookVerifyCert^^This procedural type is used for hook OnVerifyCert. By this hook you can insert your additional certificate verification code. Usefull to verify server CN against URL. ^0" +s[299] = "blcksock.THookHeartbeat^blcksock.html#THookHeartbeat^^This procedural type is used for hook OnHeartbeat. By this hook you can call your code repeately during long socket operations. You must enable heartbeats by HeartbeatRate property! ^0" +s[300] = "blcksock.TSocketFamily^blcksock.html#TSocketFamily^^Specify family of socket. SF_Any Default mode. Socket family is defined by target address for connection. It allows instant access to IPv4 and IPv6 nodes. When you need IPv6 address as destination, then is used IPv6 mode. othervise is used IPv4 mode. However this mode not working properly with preliminary IPv6 supports! SF_IP4 Turn this class to pure IPv4 mode. This mode is totally compatible with previous Synapse releases. SF_IP6 Turn to only IPv6 mode. ^0" +s[301] = "blcksock.TSocksType^blcksock.html#TSocksType^^specify possible values of SOCKS modes. ST_Socks5 ST_Socks4 ^0" +s[302] = "blcksock.TSSLType^blcksock.html#TSSLType^^Specify requested SSL/TLS version for secure connection. LT_all LT_SSLv2 LT_SSLv3 LT_TLSv1 LT_TLSv1_1 LT_SSHv2 ^0" +s[303] = "blcksock.TSynaOptionType^blcksock.html#TSynaOptionType^^Specify type of socket delayed option. SOT_Linger SOT_RecvBuff SOT_SendBuff SOT_NonBlock SOT_RecvTimeout SOT_SendTimeout SOT_Reuse SOT_TTL SOT_Broadcast SOT_MulticastTTL SOT_MulticastLoop ^0" +s[304] = "blcksock.TSSLClass^blcksock.html#TSSLClass^^ ^0" +s[305] = "blcksock.SSLImplementation^blcksock.html#SSLImplementation^^Selected SSL plugin. Default is TSSLNone.

Do not change this value directly!!!

Just add your plugin unit to your project uses instead. Each plugin unit have initialization code what modify this variable. ^0" +s[306] = "clamsend^clamsend.html^ ClamAV-daemon client^

This unit is capable to do antivirus scan of your data by TCP channel to ClamD daemon from ClamAV. See more about ClamAV on UNKNOWN ^0" +s[307] = "clamsend.TClamSend^clamsend.TClamSend.html^Implementation of ClamAV-daemon client protocol^ By this class you can scan any your data by ClamAV opensource antivirus.

This class can connect to ClamD by TCP channel, send your data to ClamD and read result. ^0" +s[308] = "clamsend.TClamSend.Create^clamsend.TClamSend.html#Create^^ ^0" +s[309] = "clamsend.TClamSend.Destroy^clamsend.TClamSend.html#Destroy^^ ^0" +s[310] = "clamsend.TClamSend.DoCommand^clamsend.TClamSend.html#DoCommand^^Call any command to ClamD. Used internally by other methods. ^0" +s[311] = "clamsend.TClamSend.GetVersion^clamsend.TClamSend.html#GetVersion^^Return ClamAV version and version of loaded databases. ^0" +s[312] = "clamsend.TClamSend.ScanStrings^clamsend.TClamSend.html#ScanStrings^^Scan content of TStrings. ^0" +s[313] = "clamsend.TClamSend.ScanStream^clamsend.TClamSend.html#ScanStream^^Scan content of TStream. ^0" +s[314] = "clamsend.TClamSend.ScanStrings2^clamsend.TClamSend.html#ScanStrings2^^Scan content of TStrings by new 0.95 API. ^0" +s[315] = "clamsend.TClamSend.ScanStream2^clamsend.TClamSend.html#ScanStream2^^Scan content of TStream by new 0.95 API. ^0" +s[316] = "clamsend.TClamSend.Sock^clamsend.TClamSend.html#Sock^^Socket object used for TCP/IP operation. Good for seting OnStatus hook, etc. ^0" +s[317] = "clamsend.TClamSend.DSock^clamsend.TClamSend.html#DSock^^Socket object used for TCP data transfer operation. Good for seting OnStatus hook, etc. ^0" +s[318] = "clamsend.TClamSend.Session^clamsend.TClamSend.html#Session^^Can turn-on session mode of communication with ClamD. Default is False, because ClamAV developers design their TCP code very badly and session mode is broken now (CVS-20051031). Maybe ClamAV developers fix their bugs and this mode will be possible in future. ^0" +s[319] = "clamsend.cClamProtocol^clamsend.html#cClamProtocol^^ ^0" +s[320] = "dnssend^dnssend.html^DNS client by UDP or TCP^ Support for sending DNS queries by UDP or TCP protocol. It can retrieve zone transfers too!

Used RFC: RFC-1035, RFC-1183, RFC1706, RFC1712, RFC2163, RFC2230 ^0" +s[321] = "dnssend.TDNSSend^dnssend.TDNSSend.html^Implementation of DNS protocol by UDP or TCP protocol.^

Note: Are you missing properties for specify server address and port? Look to parent TSynaClient too! ^0" +s[322] = "dnssend.TDNSSend.Create^dnssend.TDNSSend.html#Create^^ ^0" +s[323] = "dnssend.TDNSSend.Destroy^dnssend.TDNSSend.html#Destroy^^ ^0" +s[324] = "dnssend.TDNSSend.DNSQuery^dnssend.TDNSSend.html#DNSQuery^^Query a DNSHost for QType resources correspond to a name. Supported QType values are: Qtype_A, Qtype_NS, Qtype_MD, Qtype_MF, Qtype_CNAME, Qtype_SOA, Qtype_MB, Qtype_MG, Qtype_MR, Qtype_NULL, Qtype_PTR, Qtype_HINFO, Qtype_MINFO, Qtype_MX, Qtype_TXT, Qtype_RP, Qtype_AFSDB, Qtype_X25, Qtype_ISDN, Qtype_RT, Qtype_NSAP, Qtype_NSAPPTR, Qtype_PX, Qtype_GPOS, Qtype_KX.

Type for zone transfers QTYPE_AXFR is supported too, but only in TCP mode!

"Name" is domain name or host name for queried resource. If "name" is IP address, automatically convert to reverse domain form (.in-addr.arpa).

If result is True, Reply contains resource records. One record on one line. If Resource record have multiple fields, they are stored on line divided by comma. (example: MX record contains value 'rs.cesnet.cz' with preference number 10, string in Reply is: '10,rs.cesnet.cz'). All numbers or IP address in resource are converted to string form. ^0" +s[325] = "dnssend.TDNSSend.Sock^dnssend.TDNSSend.html#Sock^^Socket object used for UDP operation. Good for seting OnStatus hook, etc. ^0" +s[326] = "dnssend.TDNSSend.TCPSock^dnssend.TDNSSend.html#TCPSock^^Socket object used for TCP operation. Good for seting OnStatus hook, etc. ^0" +s[327] = "dnssend.TDNSSend.UseTCP^dnssend.TDNSSend.html#UseTCP^^if True, then is used TCP protocol instead UDP. It is needed for zone transfers, etc. ^0" +s[328] = "dnssend.TDNSSend.RCode^dnssend.TDNSSend.html#RCode^^After DNS operation contains ResultCode of DNS operation. Values are: 0-no error, 1-format error, 2-server failure, 3-name error, 4-not implemented, 5-refused. ^0" +s[329] = "dnssend.TDNSSend.Authoritative^dnssend.TDNSSend.html#Authoritative^^True, if answer is authoritative. ^0" +s[330] = "dnssend.TDNSSend.Truncated^dnssend.TDNSSend.html#Truncated^^True, if answer is truncated to 512 bytes. ^0" +s[331] = "dnssend.TDNSSend.AnswerInfo^dnssend.TDNSSend.html#AnswerInfo^^Detailed informations from name server reply. One record per line. Record have comma delimited entries with type number, TTL and data filelds. This information contains detailed information about query reply. ^0" +s[332] = "dnssend.TDNSSend.NameserverInfo^dnssend.TDNSSend.html#NameserverInfo^^Detailed informations from name server reply. One record per line. Record have comma delimited entries with type number, TTL and data filelds. This information contains detailed information about nameserver. ^0" +s[333] = "dnssend.TDNSSend.AdditionalInfo^dnssend.TDNSSend.html#AdditionalInfo^^Detailed informations from name server reply. One record per line. Record have comma delimited entries with type number, TTL and data filelds. This information contains detailed additional information. ^0" +s[334] = "dnssend.cDnsProtocol^dnssend.html#cDnsProtocol^^ ^0" +s[335] = "dnssend.QTYPE_A^dnssend.html#QTYPE_A^^ ^0" +s[336] = "dnssend.QTYPE_NS^dnssend.html#QTYPE_NS^^ ^0" +s[337] = "dnssend.QTYPE_MD^dnssend.html#QTYPE_MD^^ ^0" +s[338] = "dnssend.QTYPE_MF^dnssend.html#QTYPE_MF^^ ^0" +s[339] = "dnssend.QTYPE_CNAME^dnssend.html#QTYPE_CNAME^^ ^0" +s[340] = "dnssend.QTYPE_SOA^dnssend.html#QTYPE_SOA^^ ^0" +s[341] = "dnssend.QTYPE_MB^dnssend.html#QTYPE_MB^^ ^0" +s[342] = "dnssend.QTYPE_MG^dnssend.html#QTYPE_MG^^ ^0" +s[343] = "dnssend.QTYPE_MR^dnssend.html#QTYPE_MR^^ ^0" +s[344] = "dnssend.QTYPE_NULL^dnssend.html#QTYPE_NULL^^ ^0" +s[345] = "dnssend.QTYPE_WKS^dnssend.html#QTYPE_WKS^^ ^0" +s[346] = "dnssend.QTYPE_PTR^dnssend.html#QTYPE_PTR^^ ^0" +s[347] = "dnssend.QTYPE_HINFO^dnssend.html#QTYPE_HINFO^^ ^0" +s[348] = "dnssend.QTYPE_MINFO^dnssend.html#QTYPE_MINFO^^ ^0" +s[349] = "dnssend.QTYPE_MX^dnssend.html#QTYPE_MX^^ ^0" +s[350] = "dnssend.QTYPE_TXT^dnssend.html#QTYPE_TXT^^ ^0" +s[351] = "dnssend.QTYPE_RP^dnssend.html#QTYPE_RP^^ ^0" +s[352] = "dnssend.QTYPE_AFSDB^dnssend.html#QTYPE_AFSDB^^ ^0" +s[353] = "dnssend.QTYPE_X25^dnssend.html#QTYPE_X25^^ ^0" +s[354] = "dnssend.QTYPE_ISDN^dnssend.html#QTYPE_ISDN^^ ^0" +s[355] = "dnssend.QTYPE_RT^dnssend.html#QTYPE_RT^^ ^0" +s[356] = "dnssend.QTYPE_NSAP^dnssend.html#QTYPE_NSAP^^ ^0" +s[357] = "dnssend.QTYPE_NSAPPTR^dnssend.html#QTYPE_NSAPPTR^^ ^0" +s[358] = "dnssend.QTYPE_SIG^dnssend.html#QTYPE_SIG^^ ^0" +s[359] = "dnssend.QTYPE_KEY^dnssend.html#QTYPE_KEY^^ ^0" +s[360] = "dnssend.QTYPE_PX^dnssend.html#QTYPE_PX^^ ^0" +s[361] = "dnssend.QTYPE_GPOS^dnssend.html#QTYPE_GPOS^^ ^0" +s[362] = "dnssend.QTYPE_AAAA^dnssend.html#QTYPE_AAAA^^ ^0" +s[363] = "dnssend.QTYPE_LOC^dnssend.html#QTYPE_LOC^^ ^0" +s[364] = "dnssend.QTYPE_NXT^dnssend.html#QTYPE_NXT^^ ^0" +s[365] = "dnssend.QTYPE_SRV^dnssend.html#QTYPE_SRV^^ ^0" +s[366] = "dnssend.QTYPE_NAPTR^dnssend.html#QTYPE_NAPTR^^ ^0" +s[367] = "dnssend.QTYPE_KX^dnssend.html#QTYPE_KX^^ ^0" +s[368] = "dnssend.QTYPE_SPF^dnssend.html#QTYPE_SPF^^ ^0" +s[369] = "dnssend.QTYPE_AXFR^dnssend.html#QTYPE_AXFR^^ ^0" +s[370] = "dnssend.QTYPE_MAILB^dnssend.html#QTYPE_MAILB^^ ^0" +s[371] = "dnssend.QTYPE_MAILA^dnssend.html#QTYPE_MAILA^^ ^0" +s[372] = "dnssend.QTYPE_ALL^dnssend.html#QTYPE_ALL^^ ^0" +s[373] = "dnssend.GetMailServers^dnssend.html#GetMailServers^^A very useful function, and example of it's use is found in the TDNSSend object. This function is used to get mail servers for a domain and sort them by preference numbers. "Servers" contains only the domain names of the mail servers in the right order (without preference number!). The first domain name will always be the highest preferenced mail server. Returns boolean True if all went well. ^0" +s[374] = "ftpsend^ftpsend.html^^ ^0" +s[375] = "ftpsend.TFTPListRec^ftpsend.TFTPListRec.html^Object for holding file information^ parsed from directory listing of FTP server. ^0" +s[376] = "ftpsend.TFTPListRec.Assign^ftpsend.TFTPListRec.html#Assign^^You can assign another TFTPListRec to this object. ^0" +s[377] = "ftpsend.TFTPListRec.FileName^ftpsend.TFTPListRec.html#FileName^^name of file ^0" +s[378] = "ftpsend.TFTPListRec.Directory^ftpsend.TFTPListRec.html#Directory^^if name is subdirectory not file. ^0" +s[379] = "ftpsend.TFTPListRec.Readable^ftpsend.TFTPListRec.html#Readable^^if you have rights to read ^0" +s[380] = "ftpsend.TFTPListRec.FileSize^ftpsend.TFTPListRec.html#FileSize^^size of file in bytes ^0" +s[381] = "ftpsend.TFTPListRec.FileTime^ftpsend.TFTPListRec.html#FileTime^^date and time of file. Local server timezone is used. Any timezone conversions was not done! ^0" +s[382] = "ftpsend.TFTPListRec.OriginalLine^ftpsend.TFTPListRec.html#OriginalLine^^original unparsed line ^0" +s[383] = "ftpsend.TFTPListRec.Mask^ftpsend.TFTPListRec.html#Mask^^mask what was used for parsing ^0" +s[384] = "ftpsend.TFTPListRec.Permission^ftpsend.TFTPListRec.html#Permission^^permission string (depending on used mask!) ^0" +s[385] = "ftpsend.TFTPList^ftpsend.TFTPList.html^This is TList of TFTPListRec objects.^ This object is used for holding lististing of all files information in listed directory on FTP server. ^0" +s[386] = "ftpsend.TFTPList.Create^ftpsend.TFTPList.html#Create^^Constructor. You not need create this object, it is created by TFTPSend class as their property. ^0" +s[387] = "ftpsend.TFTPList.Destroy^ftpsend.TFTPList.html#Destroy^^ ^0" +s[388] = "ftpsend.TFTPList.Clear^ftpsend.TFTPList.html#Clear^^Clear list. ^0" +s[389] = "ftpsend.TFTPList.Count^ftpsend.TFTPList.html#Count^^count of holded TFTPListRec objects ^0" +s[390] = "ftpsend.TFTPList.Assign^ftpsend.TFTPList.html#Assign^^Assigns one list to another ^0" +s[391] = "ftpsend.TFTPList.ParseLines^ftpsend.TFTPList.html#ParseLines^^try to parse raw directory listing in Lines to list of TFTPListRec. ^0" +s[392] = "ftpsend.TFTPList.List^ftpsend.TFTPList.html#List^^By this property you have access to list of TFTPListRec. This is for compatibility only. Please, use Items instead. ^0" +s[393] = "ftpsend.TFTPList.Items^ftpsend.TFTPList.html#Items^^By this property you have access to list of TFTPListRec. ^0" +s[394] = "ftpsend.TFTPList.Lines^ftpsend.TFTPList.html#Lines^^Set of lines with RAW directory listing for ParseLines ^0" +s[395] = "ftpsend.TFTPList.Masks^ftpsend.TFTPList.html#Masks^^Set of masks for directory listing parser. It is predefined by default, however you can modify it as you need. (for example, you can add your own definition mask.) Mask is same as mask used in TotalCommander. ^0" +s[396] = "ftpsend.TFTPList.UnparsedLines^ftpsend.TFTPList.html#UnparsedLines^^After ParseLines it holding lines what was not sucessfully parsed. ^0" +s[397] = "ftpsend.TFTPSend^ftpsend.TFTPSend.html^Implementation of FTP protocol.^ Note: Are you missing properties for setting Username and Password? Look to parent TSynaClient object! (Username and Password have default values for "anonymous" FTP login)

Are you missing properties for specify server address and port? Look to parent TSynaClient too! ^0" +s[398] = "ftpsend.TFTPSend.CustomLogon^ftpsend.TFTPSend.html#CustomLogon^^Custom definition of login sequence. You can use this when you set FWMode to value -1. ^0" +s[399] = "ftpsend.TFTPSend.Create^ftpsend.TFTPSend.html#Create^^ ^0" +s[400] = "ftpsend.TFTPSend.Destroy^ftpsend.TFTPSend.html#Destroy^^ ^0" +s[401] = "ftpsend.TFTPSend.ReadResult^ftpsend.TFTPSend.html#ReadResult^^Waits and read FTP server response. You need this only in special cases! ^0" +s[402] = "ftpsend.TFTPSend.ParseRemote^ftpsend.TFTPSend.html#ParseRemote^^Parse remote side information of data channel from value string (returned by PASV command). This function you need only in special cases! ^0" +s[403] = "ftpsend.TFTPSend.ParseRemoteEPSV^ftpsend.TFTPSend.html#ParseRemoteEPSV^^Parse remote side information of data channel from value string (returned by EPSV command). This function you need only in special cases! ^0" +s[404] = "ftpsend.TFTPSend.FTPCommand^ftpsend.TFTPSend.html#FTPCommand^^Send Value as FTP command to FTP server. Returned result code is result of this function. This command is good for sending site specific command, or non-standard commands. ^0" +s[405] = "ftpsend.TFTPSend.Login^ftpsend.TFTPSend.html#Login^^Connect and logon to FTP server. If you specify any FireWall, connect to firewall and throw them connect to FTP server. Login sequence depending on FWMode. ^0" +s[406] = "ftpsend.TFTPSend.Logout^ftpsend.TFTPSend.html#Logout^^Logoff and disconnect from FTP server. ^0" +s[407] = "ftpsend.TFTPSend.Abort^ftpsend.TFTPSend.html#Abort^^Break current transmission of data. (You can call this method from Sock.OnStatus event, or from another thread.) ^0" +s[408] = "ftpsend.TFTPSend.TelnetAbort^ftpsend.TFTPSend.html#TelnetAbort^^Break current transmission of data. It is same as Abort, but it send abort telnet commands prior ABOR FTP command. Some servers need it. (You can call this method from Sock.OnStatus event, or from another thread.) ^0" +s[409] = "ftpsend.TFTPSend.List^ftpsend.TFTPSend.html#List^^Download directory listing of Directory on FTP server. If Directory is empty string, download listing of current working directory. If NameList is True, download only names of files in directory. (internally use NLST command instead LIST command) If NameList is False, returned list is also parsed to FtpList property. ^0" +s[410] = "ftpsend.TFTPSend.RetrieveFile^ftpsend.TFTPSend.html#RetrieveFile^^Read data from FileName on FTP server. If Restore is True and server supports resume dowloads, download is resumed. (received is only rest of file) ^0" +s[411] = "ftpsend.TFTPSend.StoreFile^ftpsend.TFTPSend.html#StoreFile^^Send data to FileName on FTP server. If Restore is True and server supports resume upload, upload is resumed. (send only rest of file) In this case if remote file is same length as local file, nothing will be done. If remote file is larger then local, resume is disabled and file is transfered from begin! ^0" +s[412] = "ftpsend.TFTPSend.StoreUniqueFile^ftpsend.TFTPSend.html#StoreUniqueFile^^Send data to FTP server and assing unique name for this file. ^0" +s[413] = "ftpsend.TFTPSend.AppendFile^ftpsend.TFTPSend.html#AppendFile^^Append data to FileName on FTP server. ^0" +s[414] = "ftpsend.TFTPSend.RenameFile^ftpsend.TFTPSend.html#RenameFile^^Rename on FTP server file with OldName to NewName. ^0" +s[415] = "ftpsend.TFTPSend.DeleteFile^ftpsend.TFTPSend.html#DeleteFile^^Delete file FileName on FTP server. ^0" +s[416] = "ftpsend.TFTPSend.FileSize^ftpsend.TFTPSend.html#FileSize^^Return size of Filename file on FTP server. If command failed (i.e. not implemented), return -1. ^0" +s[417] = "ftpsend.TFTPSend.NoOp^ftpsend.TFTPSend.html#NoOp^^Send NOOP command to FTP server for preserve of disconnect by inactivity timeout. ^0" +s[418] = "ftpsend.TFTPSend.ChangeWorkingDir^ftpsend.TFTPSend.html#ChangeWorkingDir^^Change currect working directory to Directory on FTP server. ^0" +s[419] = "ftpsend.TFTPSend.ChangeToParentDir^ftpsend.TFTPSend.html#ChangeToParentDir^^walk to upper directory on FTP server. ^0" +s[420] = "ftpsend.TFTPSend.ChangeToRootDir^ftpsend.TFTPSend.html#ChangeToRootDir^^walk to root directory on FTP server. (May not work with all servers properly!) ^0" +s[421] = "ftpsend.TFTPSend.DeleteDir^ftpsend.TFTPSend.html#DeleteDir^^Delete Directory on FTP server. ^0" +s[422] = "ftpsend.TFTPSend.CreateDir^ftpsend.TFTPSend.html#CreateDir^^Create Directory on FTP server. ^0" +s[423] = "ftpsend.TFTPSend.GetCurrentDir^ftpsend.TFTPSend.html#GetCurrentDir^^Return current working directory on FTP server. ^0" +s[424] = "ftpsend.TFTPSend.DataRead^ftpsend.TFTPSend.html#DataRead^^Establish data channel to FTP server and retrieve data. This function you need only in special cases, i.e. when you need to implement some special unsupported FTP command! ^0" +s[425] = "ftpsend.TFTPSend.DataWrite^ftpsend.TFTPSend.html#DataWrite^^Establish data channel to FTP server and send data. This function you need only in special cases, i.e. when you need to implement some special unsupported FTP command. ^0" +s[426] = "ftpsend.TFTPSend.ResultCode^ftpsend.TFTPSend.html#ResultCode^^After FTP command contains result number of this operation. ^0" +s[427] = "ftpsend.TFTPSend.ResultString^ftpsend.TFTPSend.html#ResultString^^After FTP command contains main line of result. ^0" +s[428] = "ftpsend.TFTPSend.FullResult^ftpsend.TFTPSend.html#FullResult^^After any FTP command it contains all lines of FTP server reply. ^0" +s[429] = "ftpsend.TFTPSend.Account^ftpsend.TFTPSend.html#Account^^Account information used in some cases inside login sequence. ^0" +s[430] = "ftpsend.TFTPSend.FWHost^ftpsend.TFTPSend.html#FWHost^^Address of firewall. If empty string (default), firewall not used. ^0" +s[431] = "ftpsend.TFTPSend.FWPort^ftpsend.TFTPSend.html#FWPort^^port of firewall. standard value is same port as ftp server used. (21) ^0" +s[432] = "ftpsend.TFTPSend.FWUsername^ftpsend.TFTPSend.html#FWUsername^^Username for login to firewall. (if needed) ^0" +s[433] = "ftpsend.TFTPSend.FWPassword^ftpsend.TFTPSend.html#FWPassword^^password for login to firewall. (if needed) ^0" +s[434] = "ftpsend.TFTPSend.FWMode^ftpsend.TFTPSend.html#FWMode^^Type of Firewall. Used only if you set some firewall address. Supported predefined firewall login sequences are described by comments in source file where you can see pseudocode decribing each sequence. ^0" +s[435] = "ftpsend.TFTPSend.Sock^ftpsend.TFTPSend.html#Sock^^Socket object used for TCP/IP operation on control channel. Good for seting OnStatus hook, etc. ^0" +s[436] = "ftpsend.TFTPSend.DSock^ftpsend.TFTPSend.html#DSock^^Socket object used for TCP/IP operation on data channel. Good for seting OnStatus hook, etc. ^0" +s[437] = "ftpsend.TFTPSend.DataStream^ftpsend.TFTPSend.html#DataStream^^If you not use DirectFile mode, all data transfers is made to or from this stream. ^0" +s[438] = "ftpsend.TFTPSend.DataIP^ftpsend.TFTPSend.html#DataIP^^After data connection is established, contains remote side IP of this connection. ^0" +s[439] = "ftpsend.TFTPSend.DataPort^ftpsend.TFTPSend.html#DataPort^^After data connection is established, contains remote side port of this connection. ^0" +s[440] = "ftpsend.TFTPSend.DirectFile^ftpsend.TFTPSend.html#DirectFile^^Mode of data handling by data connection. If False, all data operations are made to or from DataStream TMemoryStream. If True, data operations is made directly to file in your disk. (filename is specified by DirectFileName property.) Dafault is False! ^0" +s[441] = "ftpsend.TFTPSend.DirectFileName^ftpsend.TFTPSend.html#DirectFileName^^Filename for direct disk data operations. ^0" +s[442] = "ftpsend.TFTPSend.CanResume^ftpsend.TFTPSend.html#CanResume^^Indicate after Login if remote server support resume downloads and uploads. ^0" +s[443] = "ftpsend.TFTPSend.PassiveMode^ftpsend.TFTPSend.html#PassiveMode^^If true (default value), all transfers is made by passive method. It is safer method for various firewalls. ^0" +s[444] = "ftpsend.TFTPSend.ForceDefaultPort^ftpsend.TFTPSend.html#ForceDefaultPort^^Force to listen for dataconnection on standard port (20). Default is False, dataconnections will be made to any non-standard port reported by PORT FTP command. This setting is not used, if you use passive mode. ^0" +s[445] = "ftpsend.TFTPSend.ForceOldPort^ftpsend.TFTPSend.html#ForceOldPort^^When is True, then is disabled EPSV and EPRT support. However without this commands you cannot use IPv6! (Disabling of this commands is needed only when you are behind some crap firewall/NAT. ^0" +s[446] = "ftpsend.TFTPSend.OnStatus^ftpsend.TFTPSend.html#OnStatus^^You may set this hook for monitoring FTP commands and replies. ^0" +s[447] = "ftpsend.TFTPSend.FtpList^ftpsend.TFTPSend.html#FtpList^^After LIST command is here parsed list of files in given directory. ^0" +s[448] = "ftpsend.TFTPSend.BinaryMode^ftpsend.TFTPSend.html#BinaryMode^^if True (default), then data transfers is in binary mode. If this is set to False, then ASCII mode is used. ^0" +s[449] = "ftpsend.TFTPSend.AutoTLS^ftpsend.TFTPSend.html#AutoTLS^^if is true, then if server support upgrade to SSL/TLS mode, then use them. ^0" +s[450] = "ftpsend.TFTPSend.FullSSL^ftpsend.TFTPSend.html#FullSSL^^if server listen on SSL/TLS port, then you set this to true. ^0" +s[451] = "ftpsend.TFTPSend.IsTLS^ftpsend.TFTPSend.html#IsTLS^^Signalise, if control channel is in SSL/TLS mode. ^0" +s[452] = "ftpsend.TFTPSend.IsDataTLS^ftpsend.TFTPSend.html#IsDataTLS^^Signalise, if data transfers is in SSL/TLS mode. ^0" +s[453] = "ftpsend.TFTPSend.TLSonData^ftpsend.TFTPSend.html#TLSonData^^If True (default), then try to use SSL/TLS on data transfers too. If False, then SSL/TLS is used only for control connection. ^0" +s[454] = "ftpsend.cFtpProtocol^ftpsend.html#cFtpProtocol^^ ^0" +s[455] = "ftpsend.cFtpDataProtocol^ftpsend.html#cFtpDataProtocol^^ ^0" +s[456] = "ftpsend.FTP_OK^ftpsend.html#FTP_OK^^Terminating value for TLogonActions ^0" +s[457] = "ftpsend.FTP_ERR^ftpsend.html#FTP_ERR^^Terminating value for TLogonActions ^0" +s[458] = "ftpsend.FtpGetFile^ftpsend.html#FtpGetFile^^A very useful function, and example of use can be found in the TFtpSend object. Dowload specified file from FTP server to LocalFile. ^0" +s[459] = "ftpsend.FtpPutFile^ftpsend.html#FtpPutFile^^A very useful function, and example of use can be found in the TFtpSend object. Upload specified LocalFile to FTP server. ^0" +s[460] = "ftpsend.FtpInterServerTransfer^ftpsend.html#FtpInterServerTransfer^^A very useful function, and example of use can be found in the TFtpSend object. Initiate transfer of file between two FTP servers. ^0" +s[461] = "ftpsend.TLogonActions^ftpsend.html#TLogonActions^^Array for holding definition of logon sequence. ^0" +s[462] = "ftpsend.TFTPStatus^ftpsend.html#TFTPStatus^^Procedural type for OnStatus event. Sender is calling TFTPSend object. Value is FTP command or reply to this comand. (if it is reply, Response is True). ^0" +s[463] = "ftptsend^ftptsend.html^TFTP client and server protocol^

Used RFC: RFC-1350 ^0" +s[464] = "ftptsend.TTFTPSend^ftptsend.TTFTPSend.html^Implementation of TFTP client and server^ Note: Are you missing properties for specify server address and port? Look to parent TSynaClient too! ^0" +s[465] = "ftptsend.TTFTPSend.Create^ftptsend.TTFTPSend.html#Create^^ ^0" +s[466] = "ftptsend.TTFTPSend.Destroy^ftptsend.TTFTPSend.html#Destroy^^ ^0" +s[467] = "ftptsend.TTFTPSend.SendFile^ftptsend.TTFTPSend.html#SendFile^^Upload Data as file to TFTP server. ^0" +s[468] = "ftptsend.TTFTPSend.RecvFile^ftptsend.TTFTPSend.html#RecvFile^^Download file from TFTP server to Data. ^0" +s[469] = "ftptsend.TTFTPSend.WaitForRequest^ftptsend.TTFTPSend.html#WaitForRequest^^Acts as TFTP server and wait for client request. When some request incoming within Timeout, result is True and parametres is filled with information from request. You must handle this request, validate it, and call ReplyError, ReplyRecv or ReplySend for send reply to TFTP Client. ^0" +s[470] = "ftptsend.TTFTPSend.ReplyError^ftptsend.TTFTPSend.html#ReplyError^^send error to TFTP client, when you acts as TFTP server. ^0" +s[471] = "ftptsend.TTFTPSend.ReplyRecv^ftptsend.TTFTPSend.html#ReplyRecv^^Accept uploaded file from TFTP client to Data, when you acts as TFTP server. ^0" +s[472] = "ftptsend.TTFTPSend.ReplySend^ftptsend.TTFTPSend.html#ReplySend^^Accept download request file from TFTP client and send content of Data, when you acts as TFTP server. ^0" +s[473] = "ftptsend.TTFTPSend.ErrorCode^ftptsend.TTFTPSend.html#ErrorCode^^Code of TFTP error. ^0" +s[474] = "ftptsend.TTFTPSend.ErrorString^ftptsend.TTFTPSend.html#ErrorString^^Human readable decription of TFTP error. (if is sended by remote side) ^0" +s[475] = "ftptsend.TTFTPSend.Data^ftptsend.TTFTPSend.html#Data^^MemoryStream with datas for sending or receiving ^0" +s[476] = "ftptsend.TTFTPSend.RequestIP^ftptsend.TTFTPSend.html#RequestIP^^Address of TFTP remote side. ^0" +s[477] = "ftptsend.TTFTPSend.RequestPort^ftptsend.TTFTPSend.html#RequestPort^^Port of TFTP remote side. ^0" +s[478] = "ftptsend.cTFTPProtocol^ftptsend.html#cTFTPProtocol^^ ^0" +s[479] = "ftptsend.cTFTP_RRQ^ftptsend.html#cTFTP_RRQ^^ ^0" +s[480] = "ftptsend.cTFTP_WRQ^ftptsend.html#cTFTP_WRQ^^ ^0" +s[481] = "ftptsend.cTFTP_DTA^ftptsend.html#cTFTP_DTA^^ ^0" +s[482] = "ftptsend.cTFTP_ACK^ftptsend.html#cTFTP_ACK^^ ^0" +s[483] = "ftptsend.cTFTP_ERR^ftptsend.html#cTFTP_ERR^^ ^0" +s[484] = "httpsend^httpsend.html^^ ^0" +s[485] = "httpsend.THTTPSend^httpsend.THTTPSend.html^^abstract(Implementation of HTTP protocol.) ^0" +s[486] = "httpsend.THTTPSend.Create^httpsend.THTTPSend.html#Create^^ ^0" +s[487] = "httpsend.THTTPSend.Destroy^httpsend.THTTPSend.html#Destroy^^ ^0" +s[488] = "httpsend.THTTPSend.Clear^httpsend.THTTPSend.html#Clear^^Reset headers and document and Mimetype. ^0" +s[489] = "httpsend.THTTPSend.DecodeStatus^httpsend.THTTPSend.html#DecodeStatus^^Decode ResultCode and ResultString from Value. ^0" +s[490] = "httpsend.THTTPSend.HTTPMethod^httpsend.THTTPSend.html#HTTPMethod^^Connects to host define in URL and access to resource defined in URL by method. If Document is not empty, send it to server as part of HTTP request. Server response is in Document and headers. Connection may be authorised by username and password in URL. If you define proxy properties, connection is made by this proxy. If all OK, result is True, else result is False.

If you use in URL 'https:' instead only 'http:', then your request is made by SSL/TLS connection (if you not specify port, then port 443 is used instead standard port 80). If you use SSL/TLS request and you have defined HTTP proxy, then HTTP-tunnel mode is automaticly used . ^0" +s[491] = "httpsend.THTTPSend.Abort^httpsend.THTTPSend.html#Abort^^You can call this method from OnStatus event for break current data transfer. (or from another thread.) ^0" +s[492] = "httpsend.THTTPSend.Headers^httpsend.THTTPSend.html#Headers^^Before HTTP operation you may define any non-standard headers for HTTP request, except of: 'Expect: 100-continue', 'Content-Length', 'Content-Type', 'Connection', 'Authorization', 'Proxy-Authorization' and 'Host' headers. After HTTP operation contains full headers of returned document. ^0" +s[493] = "httpsend.THTTPSend.Cookies^httpsend.THTTPSend.html#Cookies^^This is stringlist with name-value stringlist pairs. Each this pair is one cookie. After HTTP request is returned cookies parsed to this stringlist. You can leave this cookies untouched for next HTTP request. You can also save this stringlist for later use. ^0" +s[494] = "httpsend.THTTPSend.Document^httpsend.THTTPSend.html#Document^^Stream with document to send (before request, or with document received from HTTP server (after request). ^0" +s[495] = "httpsend.THTTPSend.RangeStart^httpsend.THTTPSend.html#RangeStart^^If you need download only part of requested document, here specify possition of subpart begin. If here 0, then is requested full document. ^0" +s[496] = "httpsend.THTTPSend.RangeEnd^httpsend.THTTPSend.html#RangeEnd^^If you need download only part of requested document, here specify possition of subpart end. If here 0, then is requested document from rangeStart to end of document. (for broken download restoration, for example.) ^0" +s[497] = "httpsend.THTTPSend.MimeType^httpsend.THTTPSend.html#MimeType^^Mime type of sending data. Default is: 'text/html'. ^0" +s[498] = "httpsend.THTTPSend.Protocol^httpsend.THTTPSend.html#Protocol^^Define protocol version. Possible values are: '1.1', '1.0' (default) and '0.9'. ^0" +s[499] = "httpsend.THTTPSend.KeepAlive^httpsend.THTTPSend.html#KeepAlive^^If True (default value), keepalives in HTTP protocol 1.1 is enabled. ^0" +s[500] = "httpsend.THTTPSend.KeepAliveTimeout^httpsend.THTTPSend.html#KeepAliveTimeout^^Define timeout for keepalives in seconds! ^0" +s[501] = "httpsend.THTTPSend.Status100^httpsend.THTTPSend.html#Status100^^if True, then server is requested for 100status capability when uploading data. Default is False (off). ^0" +s[502] = "httpsend.THTTPSend.ProxyHost^httpsend.THTTPSend.html#ProxyHost^^Address of proxy server (IP address or domain name) where you want to connect in HTTPMethod method. ^0" +s[503] = "httpsend.THTTPSend.ProxyPort^httpsend.THTTPSend.html#ProxyPort^^Port number for proxy connection. Default value is 8080. ^0" +s[504] = "httpsend.THTTPSend.ProxyUser^httpsend.THTTPSend.html#ProxyUser^^Username for connect to proxy server where you want to connect in HTTPMethod method. ^0" +s[505] = "httpsend.THTTPSend.ProxyPass^httpsend.THTTPSend.html#ProxyPass^^Password for connect to proxy server where you want to connect in HTTPMethod method. ^0" +s[506] = "httpsend.THTTPSend.UserAgent^httpsend.THTTPSend.html#UserAgent^^Here you can specify custom User-Agent indentification. By default is used: 'Mozilla/4.0 (compatible; Synapse)' ^0" +s[507] = "httpsend.THTTPSend.ResultCode^httpsend.THTTPSend.html#ResultCode^^After successful HTTPMethod method contains result code of operation. ^0" +s[508] = "httpsend.THTTPSend.ResultString^httpsend.THTTPSend.html#ResultString^^After successful HTTPMethod method contains string after result code. ^0" +s[509] = "httpsend.THTTPSend.DownloadSize^httpsend.THTTPSend.html#DownloadSize^^if this value is not 0, then data download pending. In this case you have here total sice of downloaded data. It is good for draw download progressbar from OnStatus event. ^0" +s[510] = "httpsend.THTTPSend.UploadSize^httpsend.THTTPSend.html#UploadSize^^if this value is not 0, then data upload pending. In this case you have here total sice of uploaded data. It is good for draw upload progressbar from OnStatus event. ^0" +s[511] = "httpsend.THTTPSend.Sock^httpsend.THTTPSend.html#Sock^^Socket object used for TCP/IP operation. Good for seting OnStatus hook, etc. ^0" +s[512] = "httpsend.THTTPSend.AddPortNumberToHost^httpsend.THTTPSend.html#AddPortNumberToHost^^To have possibility to switch off port number in 'Host:' HTTP header, by default True. Some buggy servers not like port informations in this header. ^0" +s[513] = "httpsend.cHttpProtocol^httpsend.html#cHttpProtocol^^ ^0" +s[514] = "httpsend.HttpGetText^httpsend.html#HttpGetText^^A very usefull function, and example of use can be found in the THTTPSend object. It implements the GET method of the HTTP protocol. This function sends the GET method for URL document to an HTTP server. Returned document is in the "Response" stringlist (without any headers). Returns boolean TRUE if all went well. ^0" +s[515] = "httpsend.HttpGetBinary^httpsend.html#HttpGetBinary^^A very usefull function, and example of use can be found in the THTTPSend object. It implements the GET method of the HTTP protocol. This function sends the GET method for URL document to an HTTP server. Returned document is in the "Response" stream. Returns boolean TRUE if all went well. ^0" +s[516] = "httpsend.HttpPostBinary^httpsend.html#HttpPostBinary^^A very useful function, and example of use can be found in the THTTPSend object. It implements the POST method of the HTTP protocol. This function sends the SEND method for a URL document to an HTTP server. The document to be sent is located in "Data" stream. The returned document is in the "Data" stream. Returns boolean TRUE if all went well. ^0" +s[517] = "httpsend.HttpPostURL^httpsend.html#HttpPostURL^^A very useful function, and example of use can be found in the THTTPSend object. It implements the POST method of the HTTP protocol. This function is good for POSTing form data. It sends the POST method for a URL document to an HTTP server. You must prepare the form data in the same manner as you would the URL data, and pass this prepared data to "URLdata". The following is a sample of how the data would appear: 'name=Lukas&field1=some%20data'. The information in the field must be encoded by EncodeURLElement function. The returned document is in the "Data" stream. Returns boolean TRUE if all went well. ^0" +s[518] = "httpsend.HttpPostFile^httpsend.html#HttpPostFile^^A very useful function, and example of use can be found in the THTTPSend object. It implements the POST method of the HTTP protocol. This function sends the POST method for a URL document to an HTTP server. This function simulate posting of file by HTML form used method 'multipart/form-data'. Posting file is in DATA stream. Its name is Filename string. Fieldname is for name of formular field with file. (simulate HTML INPUT FILE) The returned document is in the ResultData Stringlist. Returns boolean TRUE if all went well. ^0" +s[519] = "httpsend.TTransferEncoding^httpsend.html#TTransferEncoding^^These encoding types are used internally by the THTTPSend object to identify the transfer data types. TE_UNKNOWN TE_IDENTITY TE_CHUNKED ^0" +s[520] = "imapsend^imapsend.html^IMAP4 rev1 protocol client^

Used RFC: RFC-2060, RFC-2595 ^0" +s[521] = "imapsend.TIMAPSend^imapsend.TIMAPSend.html^Implementation of IMAP4 protocol.^ Note: Are you missing properties for setting Username and Password? Look to parent TSynaClient object!

Are you missing properties for specify server address and port? Look to parent TSynaClient too! ^0" +s[522] = "imapsend.TIMAPSend.Create^imapsend.TIMAPSend.html#Create^^ ^0" +s[523] = "imapsend.TIMAPSend.Destroy^imapsend.TIMAPSend.html#Destroy^^ ^0" +s[524] = "imapsend.TIMAPSend.IMAPcommand^imapsend.TIMAPSend.html#IMAPcommand^^By this function you can call any IMAP command. Result of this command is in adequate properties. ^0" +s[525] = "imapsend.TIMAPSend.IMAPuploadCommand^imapsend.TIMAPSend.html#IMAPuploadCommand^^By this function you can call any IMAP command what need upload any data. Result of this command is in adequate properties. ^0" +s[526] = "imapsend.TIMAPSend.Capability^imapsend.TIMAPSend.html#Capability^^Call CAPABILITY command and fill IMAPcap property by new values. ^0" +s[527] = "imapsend.TIMAPSend.Login^imapsend.TIMAPSend.html#Login^^Connect to IMAP server and do login to this server. This command begin session. ^0" +s[528] = "imapsend.TIMAPSend.Logout^imapsend.TIMAPSend.html#Logout^^Disconnect from IMAP server and terminate session session. If exists some deleted and non-purged messages, these messages are not deleted! ^0" +s[529] = "imapsend.TIMAPSend.NoOp^imapsend.TIMAPSend.html#NoOp^^Do NOOP. It is for prevent disconnect by timeout. ^0" +s[530] = "imapsend.TIMAPSend.List^imapsend.TIMAPSend.html#List^^Lists folder names. You may specify level of listing. If you specify FromFolder as empty string, return is all folders in system. ^0" +s[531] = "imapsend.TIMAPSend.ListSearch^imapsend.TIMAPSend.html#ListSearch^^Lists folder names what match search criteria. You may specify level of listing. If you specify FromFolder as empty string, return is all folders in system. ^0" +s[532] = "imapsend.TIMAPSend.ListSubscribed^imapsend.TIMAPSend.html#ListSubscribed^^Lists subscribed folder names. You may specify level of listing. If you specify FromFolder as empty string, return is all subscribed folders in system. ^0" +s[533] = "imapsend.TIMAPSend.ListSearchSubscribed^imapsend.TIMAPSend.html#ListSearchSubscribed^^Lists subscribed folder names what matching search criteria. You may specify level of listing. If you specify FromFolder as empty string, return is all subscribed folders in system. ^0" +s[534] = "imapsend.TIMAPSend.CreateFolder^imapsend.TIMAPSend.html#CreateFolder^^Create a new folder. ^0" +s[535] = "imapsend.TIMAPSend.DeleteFolder^imapsend.TIMAPSend.html#DeleteFolder^^Delete a folder. ^0" +s[536] = "imapsend.TIMAPSend.RenameFolder^imapsend.TIMAPSend.html#RenameFolder^^Rename folder names. ^0" +s[537] = "imapsend.TIMAPSend.SubscribeFolder^imapsend.TIMAPSend.html#SubscribeFolder^^Subscribe folder. ^0" +s[538] = "imapsend.TIMAPSend.UnsubscribeFolder^imapsend.TIMAPSend.html#UnsubscribeFolder^^Unsubscribe folder. ^0" +s[539] = "imapsend.TIMAPSend.SelectFolder^imapsend.TIMAPSend.html#SelectFolder^^Select folder. ^0" +s[540] = "imapsend.TIMAPSend.SelectROFolder^imapsend.TIMAPSend.html#SelectROFolder^^Select folder, but only for reading. Any changes are not allowed! ^0" +s[541] = "imapsend.TIMAPSend.CloseFolder^imapsend.TIMAPSend.html#CloseFolder^^Close a folder. (end of Selected state) ^0" +s[542] = "imapsend.TIMAPSend.StatusFolder^imapsend.TIMAPSend.html#StatusFolder^^Ask for given status of folder. I.e. if you specify as value 'UNSEEN', result is number of unseen messages in folder. For another status indentificator check IMAP documentation and documentation of your IMAP server (each IMAP server can have their own statuses.) ^0" +s[543] = "imapsend.TIMAPSend.ExpungeFolder^imapsend.TIMAPSend.html#ExpungeFolder^^Hardly delete all messages marked as 'deleted' in current selected folder. ^0" +s[544] = "imapsend.TIMAPSend.CheckFolder^imapsend.TIMAPSend.html#CheckFolder^^Touch to folder. (use as update status of folder, etc.) ^0" +s[545] = "imapsend.TIMAPSend.AppendMess^imapsend.TIMAPSend.html#AppendMess^^Append given message to specified folder. ^0" +s[546] = "imapsend.TIMAPSend.DeleteMess^imapsend.TIMAPSend.html#DeleteMess^^'Delete' message from current selected folder. It mark message as Deleted. Real deleting will be done after sucessfull CloseFolder or ExpungeFolder ^0" +s[547] = "imapsend.TIMAPSend.FetchMess^imapsend.TIMAPSend.html#FetchMess^^Get full message from specified message in selected folder. ^0" +s[548] = "imapsend.TIMAPSend.FetchHeader^imapsend.TIMAPSend.html#FetchHeader^^Get message headers only from specified message in selected folder. ^0" +s[549] = "imapsend.TIMAPSend.MessageSize^imapsend.TIMAPSend.html#MessageSize^^Return message size of specified message from current selected folder. ^0" +s[550] = "imapsend.TIMAPSend.CopyMess^imapsend.TIMAPSend.html#CopyMess^^Copy message from current selected folder to another folder. ^0" +s[551] = "imapsend.TIMAPSend.SearchMess^imapsend.TIMAPSend.html#SearchMess^^Return message numbers from currently selected folder as result of searching. Search criteria is very complex language (see to IMAP specification) similar to SQL (but not same syntax!). ^0" +s[552] = "imapsend.TIMAPSend.SetFlagsMess^imapsend.TIMAPSend.html#SetFlagsMess^^Sets flags of message from current selected folder. ^0" +s[553] = "imapsend.TIMAPSend.GetFlagsMess^imapsend.TIMAPSend.html#GetFlagsMess^^Gets flags of message from current selected folder. ^0" +s[554] = "imapsend.TIMAPSend.AddFlagsMess^imapsend.TIMAPSend.html#AddFlagsMess^^Add flags to message's flags. ^0" +s[555] = "imapsend.TIMAPSend.DelFlagsMess^imapsend.TIMAPSend.html#DelFlagsMess^^Remove flags from message's flags. ^0" +s[556] = "imapsend.TIMAPSend.StartTLS^imapsend.TIMAPSend.html#StartTLS^^Call STARTTLS command for upgrade connection to SSL/TLS mode. ^0" +s[557] = "imapsend.TIMAPSend.GetUID^imapsend.TIMAPSend.html#GetUID^^return UID of requested message ID. ^0" +s[558] = "imapsend.TIMAPSend.FindCap^imapsend.TIMAPSend.html#FindCap^^Try to find given capabily in capabilty string returned from IMAP server. ^0" +s[559] = "imapsend.TIMAPSend.ResultString^imapsend.TIMAPSend.html#ResultString^^Status line with result of last operation. ^0" +s[560] = "imapsend.TIMAPSend.FullResult^imapsend.TIMAPSend.html#FullResult^^Full result of last IMAP operation. ^0" +s[561] = "imapsend.TIMAPSend.IMAPcap^imapsend.TIMAPSend.html#IMAPcap^^List of server capabilites. ^0" +s[562] = "imapsend.TIMAPSend.AuthDone^imapsend.TIMAPSend.html#AuthDone^^Authorization is successful done. ^0" +s[563] = "imapsend.TIMAPSend.UID^imapsend.TIMAPSend.html#UID^^Turn on or off usage of UID (unicate identificator) of messages instead only sequence numbers. ^0" +s[564] = "imapsend.TIMAPSend.SelectedFolder^imapsend.TIMAPSend.html#SelectedFolder^^Name of currently selected folder. ^0" +s[565] = "imapsend.TIMAPSend.SelectedCount^imapsend.TIMAPSend.html#SelectedCount^^Count of messages in currently selected folder. ^0" +s[566] = "imapsend.TIMAPSend.SelectedRecent^imapsend.TIMAPSend.html#SelectedRecent^^Count of not-visited messages in currently selected folder. ^0" +s[567] = "imapsend.TIMAPSend.SelectedUIDvalidity^imapsend.TIMAPSend.html#SelectedUIDvalidity^^This number with name of folder is unique indentificator of folder. (If someone delete folder and next create new folder with exactly same name of folder, this number is must be different!) ^0" +s[568] = "imapsend.TIMAPSend.AutoTLS^imapsend.TIMAPSend.html#AutoTLS^^If is set to true, then upgrade to SSL/TLS mode if remote server support it. ^0" +s[569] = "imapsend.TIMAPSend.FullSSL^imapsend.TIMAPSend.html#FullSSL^^SSL/TLS mode is used from first contact to server. Servers with full SSL/TLS mode usualy using non-standard TCP port! ^0" +s[570] = "imapsend.TIMAPSend.Sock^imapsend.TIMAPSend.html#Sock^^Socket object used for TCP/IP operation. Good for seting OnStatus hook, etc. ^0" +s[571] = "imapsend.cIMAPProtocol^imapsend.html#cIMAPProtocol^^ ^0" +s[572] = "laz_synapse^laz_synapse.html^^ ^0" +s[573] = "ldapsend^ldapsend.html^LDAP client^

Used RFC: RFC-2251, RFC-2254, RFC-2829, RFC-2830 ^0" +s[574] = "ldapsend.TLDAPAttribute^ldapsend.TLDAPAttribute.html^LDAP attribute with list of their values^ This class holding name of LDAP attribute and list of their values. This is descendant of TStringList class enhanced by some new properties. ^0" +s[575] = "ldapsend.TLDAPAttribute.AttributeName^ldapsend.TLDAPAttribute.html#AttributeName^^Name of LDAP attribute. ^0" +s[576] = "ldapsend.TLDAPAttribute.IsBinary^ldapsend.TLDAPAttribute.html#IsBinary^^Return True when attribute contains binary data. ^0" +s[577] = "ldapsend.TLDAPAttributeList^ldapsend.TLDAPAttributeList.html^List of TLDAPAttribute^ This object can hold list of TLDAPAttribute objects. ^0" +s[578] = "ldapsend.TLDAPAttributeList.Create^ldapsend.TLDAPAttributeList.html#Create^^ ^0" +s[579] = "ldapsend.TLDAPAttributeList.Destroy^ldapsend.TLDAPAttributeList.html#Destroy^^ ^0" +s[580] = "ldapsend.TLDAPAttributeList.Clear^ldapsend.TLDAPAttributeList.html#Clear^^Clear list. ^0" +s[581] = "ldapsend.TLDAPAttributeList.Count^ldapsend.TLDAPAttributeList.html#Count^^Return count of TLDAPAttribute objects in list. ^0" +s[582] = "ldapsend.TLDAPAttributeList.Add^ldapsend.TLDAPAttributeList.html#Add^^Add new TLDAPAttribute object to list. ^0" +s[583] = "ldapsend.TLDAPAttributeList.Del^ldapsend.TLDAPAttributeList.html#Del^^Delete one TLDAPAttribute object from list. ^0" +s[584] = "ldapsend.TLDAPAttributeList.Find^ldapsend.TLDAPAttributeList.html#Find^^Find and return attribute with requested name. Returns nil if not found. ^0" +s[585] = "ldapsend.TLDAPAttributeList.Get^ldapsend.TLDAPAttributeList.html#Get^^Find and return attribute value with requested name. Returns empty string if not found. ^0" +s[586] = "ldapsend.TLDAPAttributeList.Items^ldapsend.TLDAPAttributeList.html#Items^^List of TLDAPAttribute objects. ^0" +s[587] = "ldapsend.TLDAPResult^ldapsend.TLDAPResult.html^LDAP result object^ This object can hold LDAP object. (their name and all their attributes with values) ^0" +s[588] = "ldapsend.TLDAPResult.Create^ldapsend.TLDAPResult.html#Create^^ ^0" +s[589] = "ldapsend.TLDAPResult.Destroy^ldapsend.TLDAPResult.html#Destroy^^ ^0" +s[590] = "ldapsend.TLDAPResult.ObjectName^ldapsend.TLDAPResult.html#ObjectName^^Name of this LDAP object. ^0" +s[591] = "ldapsend.TLDAPResult.Attributes^ldapsend.TLDAPResult.html#Attributes^^Here is list of object attributes. ^0" +s[592] = "ldapsend.TLDAPResultList^ldapsend.TLDAPResultList.html^List of LDAP result objects^ This object can hold list of LDAP objects. (for example result of LDAP SEARCH.) ^0" +s[593] = "ldapsend.TLDAPResultList.Create^ldapsend.TLDAPResultList.html#Create^^ ^0" +s[594] = "ldapsend.TLDAPResultList.Destroy^ldapsend.TLDAPResultList.html#Destroy^^ ^0" +s[595] = "ldapsend.TLDAPResultList.Clear^ldapsend.TLDAPResultList.html#Clear^^Clear all TLDAPResult objects in list. ^0" +s[596] = "ldapsend.TLDAPResultList.Count^ldapsend.TLDAPResultList.html#Count^^Return count of TLDAPResult objects in list. ^0" +s[597] = "ldapsend.TLDAPResultList.Add^ldapsend.TLDAPResultList.html#Add^^Create and add new TLDAPResult object to list. ^0" +s[598] = "ldapsend.TLDAPResultList.Items^ldapsend.TLDAPResultList.html#Items^^List of TLDAPResult objects. ^0" +s[599] = "ldapsend.TLDAPSend^ldapsend.TLDAPSend.html^Implementation of LDAP client^ (version 2 and 3)

Note: Are you missing properties for setting Username and Password? Look to parent TSynaClient object!

Are you missing properties for specify server address and port? Look to parent TSynaClient too! ^0" +s[600] = "ldapsend.TLDAPSend.Create^ldapsend.TLDAPSend.html#Create^^ ^0" +s[601] = "ldapsend.TLDAPSend.Destroy^ldapsend.TLDAPSend.html#Destroy^^ ^0" +s[602] = "ldapsend.TLDAPSend.Login^ldapsend.TLDAPSend.html#Login^^Try to connect to LDAP server and start secure channel, when it is required. ^0" +s[603] = "ldapsend.TLDAPSend.Bind^ldapsend.TLDAPSend.html#Bind^^Try to bind to LDAP server with TSynaClient.UserName and TSynaClient.Password. If this is empty strings, then it do annonymous Bind. When you not call Bind on LDAPv3, then is automaticly used anonymous mode.

This method using plaintext transport of password! It is not secure! ^0" +s[604] = "ldapsend.TLDAPSend.BindSasl^ldapsend.TLDAPSend.html#BindSasl^^Try to bind to LDAP server with TSynaClient.UserName and TSynaClient.Password. If this is empty strings, then it do annonymous Bind. When you not call Bind on LDAPv3, then is automaticly used anonymous mode.

This method using SASL with DIGEST-MD5 method for secure transfer of your password. ^0" +s[605] = "ldapsend.TLDAPSend.Logout^ldapsend.TLDAPSend.html#Logout^^Close connection to LDAP server. ^0" +s[606] = "ldapsend.TLDAPSend.Modify^ldapsend.TLDAPSend.html#Modify^^Modify content of LDAP attribute on this object. ^0" +s[607] = "ldapsend.TLDAPSend.Add^ldapsend.TLDAPSend.html#Add^^Add list of attributes to specified object. ^0" +s[608] = "ldapsend.TLDAPSend.Delete^ldapsend.TLDAPSend.html#Delete^^Delete this LDAP object from server. ^0" +s[609] = "ldapsend.TLDAPSend.ModifyDN^ldapsend.TLDAPSend.html#ModifyDN^^Modify object name of this LDAP object. ^0" +s[610] = "ldapsend.TLDAPSend.Compare^ldapsend.TLDAPSend.html#Compare^^Try to compare Attribute value with this LDAP object. ^0" +s[611] = "ldapsend.TLDAPSend.Search^ldapsend.TLDAPSend.html#Search^^Search LDAP base for LDAP objects by Filter. ^0" +s[612] = "ldapsend.TLDAPSend.Extended^ldapsend.TLDAPSend.html#Extended^^Call any LDAPv3 extended command. ^0" +s[613] = "ldapsend.TLDAPSend.StartTLS^ldapsend.TLDAPSend.html#StartTLS^^Try to start SSL/TLS connection to LDAP server. ^0" +s[614] = "ldapsend.TLDAPSend.Version^ldapsend.TLDAPSend.html#Version^^Specify version of used LDAP protocol. Default value is 3. ^0" +s[615] = "ldapsend.TLDAPSend.ResultCode^ldapsend.TLDAPSend.html#ResultCode^^Result code of last LDAP operation. ^0" +s[616] = "ldapsend.TLDAPSend.ResultString^ldapsend.TLDAPSend.html#ResultString^^Human readable description of result code of last LDAP operation. ^0" +s[617] = "ldapsend.TLDAPSend.FullResult^ldapsend.TLDAPSend.html#FullResult^^Binary string with full last response of LDAP server. This string is encoded by ASN.1 BER encoding! You need this only for debugging. ^0" +s[618] = "ldapsend.TLDAPSend.AutoTLS^ldapsend.TLDAPSend.html#AutoTLS^^If True, then try to start TSL mode in Login procedure. ^0" +s[619] = "ldapsend.TLDAPSend.FullSSL^ldapsend.TLDAPSend.html#FullSSL^^If True, then use connection to LDAP server through SSL/TLS tunnel. ^0" +s[620] = "ldapsend.TLDAPSend.Seq^ldapsend.TLDAPSend.html#Seq^^Sequence number of last LDAp command. It is incremented by any LDAP command. ^0" +s[621] = "ldapsend.TLDAPSend.SearchScope^ldapsend.TLDAPSend.html#SearchScope^^Specify what search scope is used in search command. ^0" +s[622] = "ldapsend.TLDAPSend.SearchAliases^ldapsend.TLDAPSend.html#SearchAliases^^Specify how to handle aliases in search command. ^0" +s[623] = "ldapsend.TLDAPSend.SearchSizeLimit^ldapsend.TLDAPSend.html#SearchSizeLimit^^Specify result size limit in search command. Value 0 means without limit. ^0" +s[624] = "ldapsend.TLDAPSend.SearchTimeLimit^ldapsend.TLDAPSend.html#SearchTimeLimit^^Specify search time limit in search command (seconds). Value 0 means without limit. ^0" +s[625] = "ldapsend.TLDAPSend.SearchResult^ldapsend.TLDAPSend.html#SearchResult^^Here is result of search command. ^0" +s[626] = "ldapsend.TLDAPSend.Referals^ldapsend.TLDAPSend.html#Referals^^On each LDAP operation can LDAP server return some referals URLs. Here is their list. ^0" +s[627] = "ldapsend.TLDAPSend.ExtName^ldapsend.TLDAPSend.html#ExtName^^When you call Extended operation, then here is result Name returned by server. ^0" +s[628] = "ldapsend.TLDAPSend.ExtValue^ldapsend.TLDAPSend.html#ExtValue^^When you call Extended operation, then here is result Value returned by server. ^0" +s[629] = "ldapsend.TLDAPSend.Sock^ldapsend.TLDAPSend.html#Sock^^TCP socket used by all LDAP operations. ^0" +s[630] = "ldapsend.cLDAPProtocol^ldapsend.html#cLDAPProtocol^^ ^0" +s[631] = "ldapsend.LDAP_ASN1_BIND_REQUEST^ldapsend.html#LDAP_ASN1_BIND_REQUEST^^ ^0" +s[632] = "ldapsend.LDAP_ASN1_BIND_RESPONSE^ldapsend.html#LDAP_ASN1_BIND_RESPONSE^^ ^0" +s[633] = "ldapsend.LDAP_ASN1_UNBIND_REQUEST^ldapsend.html#LDAP_ASN1_UNBIND_REQUEST^^ ^0" +s[634] = "ldapsend.LDAP_ASN1_SEARCH_REQUEST^ldapsend.html#LDAP_ASN1_SEARCH_REQUEST^^ ^0" +s[635] = "ldapsend.LDAP_ASN1_SEARCH_ENTRY^ldapsend.html#LDAP_ASN1_SEARCH_ENTRY^^ ^0" +s[636] = "ldapsend.LDAP_ASN1_SEARCH_DONE^ldapsend.html#LDAP_ASN1_SEARCH_DONE^^ ^0" +s[637] = "ldapsend.LDAP_ASN1_SEARCH_REFERENCE^ldapsend.html#LDAP_ASN1_SEARCH_REFERENCE^^ ^0" +s[638] = "ldapsend.LDAP_ASN1_MODIFY_REQUEST^ldapsend.html#LDAP_ASN1_MODIFY_REQUEST^^ ^0" +s[639] = "ldapsend.LDAP_ASN1_MODIFY_RESPONSE^ldapsend.html#LDAP_ASN1_MODIFY_RESPONSE^^ ^0" +s[640] = "ldapsend.LDAP_ASN1_ADD_REQUEST^ldapsend.html#LDAP_ASN1_ADD_REQUEST^^ ^0" +s[641] = "ldapsend.LDAP_ASN1_ADD_RESPONSE^ldapsend.html#LDAP_ASN1_ADD_RESPONSE^^ ^0" +s[642] = "ldapsend.LDAP_ASN1_DEL_REQUEST^ldapsend.html#LDAP_ASN1_DEL_REQUEST^^ ^0" +s[643] = "ldapsend.LDAP_ASN1_DEL_RESPONSE^ldapsend.html#LDAP_ASN1_DEL_RESPONSE^^ ^0" +s[644] = "ldapsend.LDAP_ASN1_MODIFYDN_REQUEST^ldapsend.html#LDAP_ASN1_MODIFYDN_REQUEST^^ ^0" +s[645] = "ldapsend.LDAP_ASN1_MODIFYDN_RESPONSE^ldapsend.html#LDAP_ASN1_MODIFYDN_RESPONSE^^ ^0" +s[646] = "ldapsend.LDAP_ASN1_COMPARE_REQUEST^ldapsend.html#LDAP_ASN1_COMPARE_REQUEST^^ ^0" +s[647] = "ldapsend.LDAP_ASN1_COMPARE_RESPONSE^ldapsend.html#LDAP_ASN1_COMPARE_RESPONSE^^ ^0" +s[648] = "ldapsend.LDAP_ASN1_ABANDON_REQUEST^ldapsend.html#LDAP_ASN1_ABANDON_REQUEST^^ ^0" +s[649] = "ldapsend.LDAP_ASN1_EXT_REQUEST^ldapsend.html#LDAP_ASN1_EXT_REQUEST^^ ^0" +s[650] = "ldapsend.LDAP_ASN1_EXT_RESPONSE^ldapsend.html#LDAP_ASN1_EXT_RESPONSE^^ ^0" +s[651] = "ldapsend.LDAPResultDump^ldapsend.html#LDAPResultDump^^Dump result of LDAP SEARCH into human readable form. Good for debugging. ^0" +s[652] = "ldapsend.TLDAPModifyOp^ldapsend.html#TLDAPModifyOp^^Define possible operations for LDAP MODIFY operations. MO_Add MO_Delete MO_Replace ^0" +s[653] = "ldapsend.TLDAPSearchScope^ldapsend.html#TLDAPSearchScope^^Specify possible values for search scope. SS_BaseObject SS_SingleLevel SS_WholeSubtree ^0" +s[654] = "ldapsend.TLDAPSearchAliases^ldapsend.html#TLDAPSearchAliases^^Specify possible values about alias dereferencing. SA_NeverDeref SA_InSearching SA_FindingBaseObj SA_Always ^0" +s[655] = "mimeinln^mimeinln.html^Utilities for inline MIME^ Support for Inline MIME encoding and decoding.

Used RFC: RFC-2047, RFC-2231 ^0" +s[656] = "mimeinln.InlineDecode^mimeinln.html#InlineDecode^^Decodes mime inline encoding (i.e. in headers) uses target characterset "CP". ^0" +s[657] = "mimeinln.InlineEncode^mimeinln.html#InlineEncode^^Encodes string to MIME inline encoding. The source characterset is "CP", and the target charset is "MimeP". ^0" +s[658] = "mimeinln.NeedInline^mimeinln.html#NeedInline^^Returns True, if "Value" contains characters needed for inline coding. ^0" +s[659] = "mimeinln.InlineCodeEx^mimeinln.html#InlineCodeEx^^Inline mime encoding similar to InlineEncode, but you can specify source charset, and the target characterset is automatically assigned. ^0" +s[660] = "mimeinln.InlineCode^mimeinln.html#InlineCode^^Inline MIME encoding similar to InlineEncode, but the source charset is automatically set to the system default charset, and the target charset is automatically assigned from set of allowed encoding for MIME. ^0" +s[661] = "mimeinln.InlineEmailEx^mimeinln.html#InlineEmailEx^^Converts e-mail address to canonical mime form. You can specify source charset. ^0" +s[662] = "mimeinln.InlineEmail^mimeinln.html#InlineEmail^^Converts e-mail address to canonical mime form. Source charser it system default charset. ^0" +s[663] = "mimemess^mimemess.html^MIME message handling^ Classes for easy handling with e-mail message. ^0" +s[664] = "mimemess.TMessHeader^mimemess.TMessHeader.html^Object for basic e-mail header fields.^ ^0" +s[665] = "mimemess.TMessHeader.Create^mimemess.TMessHeader.html#Create^^ ^0" +s[666] = "mimemess.TMessHeader.Destroy^mimemess.TMessHeader.html#Destroy^^ ^0" +s[667] = "mimemess.TMessHeader.Clear^mimemess.TMessHeader.html#Clear^^Clears all data fields. ^0" +s[668] = "mimemess.TMessHeader.EncodeHeaders^mimemess.TMessHeader.html#EncodeHeaders^^ ^0" +s[669] = "mimemess.TMessHeader.DecodeHeaders^mimemess.TMessHeader.html#DecodeHeaders^^Parse header from Value to this object. ^0" +s[670] = "mimemess.TMessHeader.FindHeader^mimemess.TMessHeader.html#FindHeader^^Try find specific header in CustomHeader. Search is case insensitive. This is good for reading any non-parsed header. ^0" +s[671] = "mimemess.TMessHeader.FindHeaderList^mimemess.TMessHeader.html#FindHeaderList^^Try find specific headers in CustomHeader. This metod is for repeatly used headers like 'received' header, etc. Search is case insensitive. This is good for reading ano non-parsed header. ^0" +s[672] = "mimemess.TMessHeader.From^mimemess.TMessHeader.html#From^^Sender of message. ^0" +s[673] = "mimemess.TMessHeader.ToList^mimemess.TMessHeader.html#ToList^^Stringlist with receivers of message. (one per line) ^0" +s[674] = "mimemess.TMessHeader.CCList^mimemess.TMessHeader.html#CCList^^Stringlist with Carbon Copy receivers of message. (one per line) ^0" +s[675] = "mimemess.TMessHeader.Subject^mimemess.TMessHeader.html#Subject^^Subject of message. ^0" +s[676] = "mimemess.TMessHeader.Organization^mimemess.TMessHeader.html#Organization^^Organization string. ^0" +s[677] = "mimemess.TMessHeader.CustomHeaders^mimemess.TMessHeader.html#CustomHeaders^^After decoding contains all headers lines witch not have parsed to any other structures in this object. It mean: this conatins all other headers except:

When you encode headers, all this lines is added as headers. Be carefull for duplicites! ^0" +s[678] = "mimemess.TMessHeader.Date^mimemess.TMessHeader.html#Date^^Date and time of message. ^0" +s[679] = "mimemess.TMessHeader.XMailer^mimemess.TMessHeader.html#XMailer^^Mailer identification. ^0" +s[680] = "mimemess.TMessHeader.ReplyTo^mimemess.TMessHeader.html#ReplyTo^^Address for replies ^0" +s[681] = "mimemess.TMessHeader.MessageID^mimemess.TMessHeader.html#MessageID^^message indetifier ^0" +s[682] = "mimemess.TMessHeader.Priority^mimemess.TMessHeader.html#Priority^^message priority ^0" +s[683] = "mimemess.TMessHeader.CharsetCode^mimemess.TMessHeader.html#CharsetCode^^Specify base charset. By default is used system charset. ^0" +s[684] = "mimemess.TMimeMess^mimemess.TMimeMess.html^Object for handling of e-mail message.^ ^0" +s[685] = "mimemess.TMimeMess.Create^mimemess.TMimeMess.html#Create^^ ^0" +s[686] = "mimemess.TMimeMess.CreateAltHeaders^mimemess.TMimeMess.html#CreateAltHeaders^^create this object and assign your own descendant of TMessHeader object to Header property. So, you can create your own message headers parser and use it by this object. ^0" +s[687] = "mimemess.TMimeMess.Destroy^mimemess.TMimeMess.html#Destroy^^ ^0" +s[688] = "mimemess.TMimeMess.Clear^mimemess.TMimeMess.html#Clear^^Reset component to default state. ^0" +s[689] = "mimemess.TMimeMess.AddPart^mimemess.TMimeMess.html#AddPart^^Add MIME part as subpart of PartParent. If you need set root MIME part, then set as PartParent Nil value. If you need set more then one subpart, you must have PartParent of multipart type! ^0" +s[690] = "mimemess.TMimeMess.AddPartMultipart^mimemess.TMimeMess.html#AddPartMultipart^^Add MIME part as subpart of PartParent. If you need set root MIME part, then set as PartParent Nil value. If you need set more then 1 subpart, you must have PartParent of multipart type!

This part is marked as multipart with secondary MIME type specified by MultipartType parameter. (typical value is 'mixed')

This part can be used as PartParent for another parts (include next multipart). If you need only one part, then you not need Multipart part. ^0" +s[691] = "mimemess.TMimeMess.AddPartText^mimemess.TMimeMess.html#AddPartText^^Add MIME part as subpart of PartParent. If you need set root MIME part, then set as PartParent Nil value. If you need set more then 1 subpart, you must have PartParent of multipart type!

After creation of part set type to text part and set all necessary properties. Content of part is readed from value stringlist. ^0" +s[692] = "mimemess.TMimeMess.AddPartTextEx^mimemess.TMimeMess.html#AddPartTextEx^^Add MIME part as subpart of PartParent. If you need set root MIME part, then set as PartParent Nil value. If you need set more then 1 subpart, you must have PartParent of multipart type!

After creation of part set type to text part and set all necessary properties. Content of part is readed from value stringlist. You can select your charset and your encoding type. If Raw is True, then it not doing charset conversion! ^0" +s[693] = "mimemess.TMimeMess.AddPartHTML^mimemess.TMimeMess.html#AddPartHTML^^Add MIME part as subpart of PartParent. If you need set root MIME part, then set as PartParent Nil value. If you need set more then 1 subpart, you must have PartParent of multipart type!

After creation of part set type to text part to HTML type and set all necessary properties. Content of HTML part is readed from Value stringlist. ^0" +s[694] = "mimemess.TMimeMess.AddPartTextFromFile^mimemess.TMimeMess.html#AddPartTextFromFile^^Same as AddPartText, but content is readed from file ^0" +s[695] = "mimemess.TMimeMess.AddPartHTMLFromFile^mimemess.TMimeMess.html#AddPartHTMLFromFile^^Same as AddPartHTML, but content is readed from file ^0" +s[696] = "mimemess.TMimeMess.AddPartBinary^mimemess.TMimeMess.html#AddPartBinary^^Add MIME part as subpart of PartParent. If you need set root MIME part, then set as PartParent Nil value. If you need set more then 1 subpart, you must have PartParent of multipart type!

After creation of part set type to binary and set all necessary properties. MIME primary and secondary types defined automaticly by filename extension. Content of binary part is readed from Stream. This binary part is encoded as file attachment. ^0" +s[697] = "mimemess.TMimeMess.AddPartBinaryFromFile^mimemess.TMimeMess.html#AddPartBinaryFromFile^^Same as AddPartBinary, but content is readed from file ^0" +s[698] = "mimemess.TMimeMess.AddPartHTMLBinary^mimemess.TMimeMess.html#AddPartHTMLBinary^^Add MIME part as subpart of PartParent. If you need set root MIME part, then set as PartParent Nil value. If you need set more then 1 subpart, you must have PartParent of multipart type!

After creation of part set type to binary and set all necessary properties. MIME primary and secondary types defined automaticly by filename extension. Content of binary part is readed from Stream.

This binary part is encoded as inline data with given Conten ID (cid). Content ID can be used as reference ID in HTML source in HTML part. ^0" +s[699] = "mimemess.TMimeMess.AddPartHTMLBinaryFromFile^mimemess.TMimeMess.html#AddPartHTMLBinaryFromFile^^Same as AddPartHTMLBinary, but content is readed from file ^0" +s[700] = "mimemess.TMimeMess.AddPartMess^mimemess.TMimeMess.html#AddPartMess^^Add MIME part as subpart of PartParent. If you need set root MIME part, then set as PartParent Nil value. If you need set more then 1 subpart, you must have PartParent of multipart type!

After creation of part set type to message and set all necessary properties. MIME primary and secondary types are setted to 'message/rfc822'. Content of raw RFC-822 message is readed from Stream. ^0" +s[701] = "mimemess.TMimeMess.AddPartMessFromFile^mimemess.TMimeMess.html#AddPartMessFromFile^^Same as AddPartMess, but content is readed from file ^0" +s[702] = "mimemess.TMimeMess.EncodeMessage^mimemess.TMimeMess.html#EncodeMessage^^Compose message from MessagePart to Lines. Headers from Header object is added also. ^0" +s[703] = "mimemess.TMimeMess.DecodeMessage^mimemess.TMimeMess.html#DecodeMessage^^Decode message from Lines to MessagePart. Massage headers are parsed into Header object. ^0" +s[704] = "mimemess.TMimeMess.DecodeMessageBinary^mimemess.TMimeMess.html#DecodeMessageBinary^^HTTP message is received by THTTPSend component in two parts: headers are stored in THTTPSend.Headers and a body in memory stream THTTPSend.Document.

On the top of it, HTTP connections are always 8-bit, hence data are transferred in native format i.e. no transfer encoding is applied.

This method operates the similiar way and produces the same result as DecodeMessage. ^0" +s[705] = "mimemess.TMimeMess.MessagePart^mimemess.TMimeMess.html#MessagePart^^TMimePart object with decoded MIME message. This object can handle any number of nested TMimePart objects itself. It is used for handle any tree of MIME subparts. ^0" +s[706] = "mimemess.TMimeMess.Lines^mimemess.TMimeMess.html#Lines^^Raw MIME encoded message. ^0" +s[707] = "mimemess.TMimeMess.Header^mimemess.TMimeMess.html#Header^^Object for e-mail header fields. This object is created automaticly. Do not free this object! ^0" +s[708] = "mimemess.TMessPriority^mimemess.html#TMessPriority^^Possible values for message priority MP_unknown MP_low MP_normal MP_high ^0" +s[709] = "mimemess.TMessHeaderClass^mimemess.html#TMessHeaderClass^^ ^0" +s[710] = "mimepart^mimepart.html^MIME part handling^ Handling with MIME parts.

Used RFC: RFC-2045 ^0" +s[711] = "mimepart.TMimePart^mimepart.TMimePart.html^Object for working with parts of MIME e-mail.^ Each TMimePart object can handle any number of nested subparts as new TMimepart objects. It can handle any tree hierarchy structure of nested MIME subparts itself.

Basic tasks are:

Encoding of MIME message:

- if you need multipart message, you must create subpart by AddSubPart. - set all properties of all parts. - set content of part into DecodedLines stream - encode this stream by EncodePart. - compose full message by ComposeParts. (it build full MIME message from all subparts. Do not call this method for each subpart! It is needed on root part!) - encoded MIME message is stored in Lines property. ^0" +s[712] = "mimepart.TMimePart.Create^mimepart.TMimePart.html#Create^^ ^0" +s[713] = "mimepart.TMimePart.Destroy^mimepart.TMimePart.html#Destroy^^ ^0" +s[714] = "mimepart.TMimePart.Assign^mimepart.TMimePart.html#Assign^^Assign content of another object to this object. (Only this part, not subparts!) ^0" +s[715] = "mimepart.TMimePart.AssignSubParts^mimepart.TMimePart.html#AssignSubParts^^Assign content of another object to this object. (With all subparts!) ^0" +s[716] = "mimepart.TMimePart.Clear^mimepart.TMimePart.html#Clear^^Clear all data values to default values. It also call ClearSubParts. ^0" +s[717] = "mimepart.TMimePart.DecodePart^mimepart.TMimePart.html#DecodePart^^Decode Mime part from Lines to DecodedLines. ^0" +s[718] = "mimepart.TMimePart.DecodePartHeader^mimepart.TMimePart.html#DecodePartHeader^^Parse header lines from Headers property into another properties. ^0" +s[719] = "mimepart.TMimePart.EncodePart^mimepart.TMimePart.html#EncodePart^^Encode mime part from DecodedLines to Lines and build mime headers. ^0" +s[720] = "mimepart.TMimePart.EncodePartHeader^mimepart.TMimePart.html#EncodePartHeader^^Build header lines in Headers property from another properties. ^0" +s[721] = "mimepart.TMimePart.MimeTypeFromExt^mimepart.TMimePart.html#MimeTypeFromExt^^generate primary and secondary mime type from filename extension in value. If type not recognised, it return 'Application/octet-string' type. ^0" +s[722] = "mimepart.TMimePart.GetSubPartCount^mimepart.TMimePart.html#GetSubPartCount^^Return number of decomposed subparts. (On this level! Each of this subparts can hold any number of their own nested subparts!) ^0" +s[723] = "mimepart.TMimePart.GetSubPart^mimepart.TMimePart.html#GetSubPart^^Get nested subpart object as new TMimePart. For getting maximum possible index you can use GetSubPartCount method. ^0" +s[724] = "mimepart.TMimePart.DeleteSubPart^mimepart.TMimePart.html#DeleteSubPart^^delete subpart on given index. ^0" +s[725] = "mimepart.TMimePart.ClearSubParts^mimepart.TMimePart.html#ClearSubParts^^Clear and destroy all subpart TMimePart objects. ^0" +s[726] = "mimepart.TMimePart.AddSubPart^mimepart.TMimePart.html#AddSubPart^^Add and create new subpart. ^0" +s[727] = "mimepart.TMimePart.DecomposeParts^mimepart.TMimePart.html#DecomposeParts^^E-mail message in Lines property is parsed into this object. E-mail headers are stored in Headers property and is parsed into another properties automaticly. Not need call DecodePartHeader! Content of message (part) is stored into PartBody property. This part is in undecoded form! If you need decode it, then you must call DecodePart method by your hands. Lot of another properties is filled also.

Decoding of parts you must call separately due performance reasons. (Not needed to decode all parts in all reasons.)

For each MIME subpart is created new TMimepart object (accessible via method GetSubPart). ^0" +s[728] = "mimepart.TMimePart.DecomposePartsBinary^mimepart.TMimePart.html#DecomposePartsBinary^^HTTP message is received by THTTPSend component in two parts: headers are stored in THTTPSend.Headers and a body in memory stream THTTPSend.Document.

On the top of it, HTTP connections are always 8-bit, hence data are transferred in native format i.e. no transfer encoding is applied.

This method operates the similiar way and produces the same result as DecomposeParts. ^0" +s[729] = "mimepart.TMimePart.ComposeParts^mimepart.TMimePart.html#ComposeParts^^This part and all subparts is composed into one MIME message stored in Lines property. ^0" +s[730] = "mimepart.TMimePart.WalkPart^mimepart.TMimePart.html#WalkPart^^By calling this method is called OnWalkPart event for each part and their subparts. It is very good for calling some code for each part in MIME message ^0" +s[731] = "mimepart.TMimePart.CanSubPart^mimepart.TMimePart.html#CanSubPart^^Return True when is possible create next subpart. (MaxSubLevel is still not reached) ^0" +s[732] = "mimepart.TMimePart.Primary^mimepart.TMimePart.html#Primary^^Primary Mime type of part. (i.e. 'application') Writing to this property automaticly generate value of PrimaryCode. ^0" +s[733] = "mimepart.TMimePart.Encoding^mimepart.TMimePart.html#Encoding^^String representation of used Mime encoding in part. (i.e. 'base64') Writing to this property automaticly generate value of EncodingCode. ^0" +s[734] = "mimepart.TMimePart.Charset^mimepart.TMimePart.html#Charset^^String representation of used Mime charset in part. (i.e. 'iso-8859-1') Writing to this property automaticly generate value of CharsetCode. Charset is used only for text parts. ^0" +s[735] = "mimepart.TMimePart.DefaultCharset^mimepart.TMimePart.html#DefaultCharset^^Define default charset for decoding text MIME parts without charset specification. Default value is 'ISO-8859-1' by RCF documents. But Microsoft Outlook use windows codings as default. This property allows properly decode textual parts from some broken versions of Microsoft Outlook. (this is bad software!) ^0" +s[736] = "mimepart.TMimePart.PrimaryCode^mimepart.TMimePart.html#PrimaryCode^^Decoded primary type. Possible values are: MP_TEXT, MP_MULTIPART, MP_MESSAGE and MP_BINARY. If type not recognised, result is MP_BINARY. ^0" +s[737] = "mimepart.TMimePart.EncodingCode^mimepart.TMimePart.html#EncodingCode^^Decoded encoding type. Possible values are: ME_7BIT, ME_8BIT, ME_QUOTED_PRINTABLE and ME_BASE64. If type not recognised, result is ME_7BIT. ^0" +s[738] = "mimepart.TMimePart.CharsetCode^mimepart.TMimePart.html#CharsetCode^^Decoded charset type. Possible values are defined in synachar unit. ^0" +s[739] = "mimepart.TMimePart.TargetCharset^mimepart.TMimePart.html#TargetCharset^^System charset type. Default value is charset used by default in your operating system. ^0" +s[740] = "mimepart.TMimePart.ConvertCharset^mimepart.TMimePart.html#ConvertCharset^^If True, then do internal charset translation of part content between CharsetCode and TargetCharset ^0" +s[741] = "mimepart.TMimePart.ForcedHTMLConvert^mimepart.TMimePart.html#ForcedHTMLConvert^^If True, then allways do internal charset translation of HTML parts by MIME even it have their own charset in META tag. Default is False. ^0" +s[742] = "mimepart.TMimePart.Secondary^mimepart.TMimePart.html#Secondary^^Secondary Mime type of part. (i.e. 'mixed') ^0" +s[743] = "mimepart.TMimePart.Description^mimepart.TMimePart.html#Description^^Description of Mime part. ^0" +s[744] = "mimepart.TMimePart.Disposition^mimepart.TMimePart.html#Disposition^^Value of content disposition field. (i.e. 'inline' or 'attachment') ^0" +s[745] = "mimepart.TMimePart.ContentID^mimepart.TMimePart.html#ContentID^^Content ID. ^0" +s[746] = "mimepart.TMimePart.Boundary^mimepart.TMimePart.html#Boundary^^Boundary delimiter of multipart Mime part. Used only in multipart part. ^0" +s[747] = "mimepart.TMimePart.FileName^mimepart.TMimePart.html#FileName^^Filename of file in binary part. ^0" +s[748] = "mimepart.TMimePart.Lines^mimepart.TMimePart.html#Lines^^String list with lines contains mime part (It can be a full message). ^0" +s[749] = "mimepart.TMimePart.PartBody^mimepart.TMimePart.html#PartBody^^Encoded form of MIME part data. ^0" +s[750] = "mimepart.TMimePart.Headers^mimepart.TMimePart.html#Headers^^All header lines of MIME part. ^0" +s[751] = "mimepart.TMimePart.PrePart^mimepart.TMimePart.html#PrePart^^On multipart this contains part of message between first line of message and first boundary. ^0" +s[752] = "mimepart.TMimePart.PostPart^mimepart.TMimePart.html#PostPart^^On multipart this contains part of message between last boundary and end of message. ^0" +s[753] = "mimepart.TMimePart.DecodedLines^mimepart.TMimePart.html#DecodedLines^^Stream with decoded form of budy part. ^0" +s[754] = "mimepart.TMimePart.SubLevel^mimepart.TMimePart.html#SubLevel^^Show nested level in subpart tree. Value 0 means root part. 1 means subpart from this root. etc. ^0" +s[755] = "mimepart.TMimePart.MaxSubLevel^mimepart.TMimePart.html#MaxSubLevel^^Specify maximum sublevel value for decomposing. ^0" +s[756] = "mimepart.TMimePart.AttachInside^mimepart.TMimePart.html#AttachInside^^When is True, then this part maybe(!) have included some uuencoded binary data. ^0" +s[757] = "mimepart.TMimePart.OnWalkPart^mimepart.TMimePart.html#OnWalkPart^^Here you can assign hook procedure for walking through all part and their subparts. ^0" +s[758] = "mimepart.TMimePart.MaxLineLength^mimepart.TMimePart.html#MaxLineLength^^Here you can specify maximum line length for encoding of MIME part. If line is longer, then is splitted by standard of MIME. Correct MIME mailers can de-split this line into original length. ^0" +s[759] = "mimepart.MaxMimeType^mimepart.html#MaxMimeType^^ ^0" +s[760] = "mimepart.MimeType^mimepart.html#MimeType^^ ^0" +s[761] = "mimepart.GenerateBoundary^mimepart.html#GenerateBoundary^^Generates a unique boundary string. ^0" +s[762] = "mimepart.THookWalkPart^mimepart.html#THookWalkPart^Procedural type for TMimePart.WalkPart hook^. This hook is used for easy walking through MIME subparts. ^0" +s[763] = "mimepart.TMimePrimary^mimepart.html#TMimePrimary^^The four types of MIME parts. (textual, multipart, message or any other binary data.) MP_TEXT MP_MULTIPART MP_MESSAGE MP_BINARY ^0" +s[764] = "mimepart.TMimeEncoding^mimepart.html#TMimeEncoding^^The various types of possible part encodings. ME_7BIT ME_8BIT ME_QUOTED_PRINTABLE ME_BASE64 ME_UU ME_XX ^0" +s[765] = "nntpsend^nntpsend.html^NNTP client^ NNTP (network news transfer protocol)

Used RFC: RFC-977, RFC-2980 ^0" +s[766] = "nntpsend.TNNTPSend^nntpsend.TNNTPSend.html^^abstract(Implementation of Network News Transfer Protocol.

Note: Are you missing properties for setting Username and Password? Look to parent TSynaClient object!

Are you missing properties for specify server address and port? Look to parent TSynaClient too! ^0" +s[767] = "nntpsend.TNNTPSend.Create^nntpsend.TNNTPSend.html#Create^^ ^0" +s[768] = "nntpsend.TNNTPSend.Destroy^nntpsend.TNNTPSend.html#Destroy^^ ^0" +s[769] = "nntpsend.TNNTPSend.Login^nntpsend.TNNTPSend.html#Login^^Connects to NNTP server and begin session. ^0" +s[770] = "nntpsend.TNNTPSend.Logout^nntpsend.TNNTPSend.html#Logout^^Logout from NNTP server and terminate session. ^0" +s[771] = "nntpsend.TNNTPSend.DoCommand^nntpsend.TNNTPSend.html#DoCommand^^By this you can call any NNTP command. ^0" +s[772] = "nntpsend.TNNTPSend.DoCommandRead^nntpsend.TNNTPSend.html#DoCommandRead^^by this you can call any NNTP command. This variant is used for commands for download information from server. ^0" +s[773] = "nntpsend.TNNTPSend.DoCommandWrite^nntpsend.TNNTPSend.html#DoCommandWrite^^by this you can call any NNTP command. This variant is used for commands for upload information to server. ^0" +s[774] = "nntpsend.TNNTPSend.GetArticle^nntpsend.TNNTPSend.html#GetArticle^^Download full message to Data property. Value can be number of message or message-id (in brackets). ^0" +s[775] = "nntpsend.TNNTPSend.GetBody^nntpsend.TNNTPSend.html#GetBody^^Download only body of message to Data property. Value can be number of message or message-id (in brackets). ^0" +s[776] = "nntpsend.TNNTPSend.GetHead^nntpsend.TNNTPSend.html#GetHead^^Download only headers of message to Data property. Value can be number of message or message-id (in brackets). ^0" +s[777] = "nntpsend.TNNTPSend.GetStat^nntpsend.TNNTPSend.html#GetStat^^Get message status. Value can be number of message or message-id (in brackets). ^0" +s[778] = "nntpsend.TNNTPSend.SelectGroup^nntpsend.TNNTPSend.html#SelectGroup^^Select given group. ^0" +s[779] = "nntpsend.TNNTPSend.IHave^nntpsend.TNNTPSend.html#IHave^^Tell to server 'I have mesage with given message-ID.' If server need this message, message is uploaded to server. ^0" +s[780] = "nntpsend.TNNTPSend.GotoLast^nntpsend.TNNTPSend.html#GotoLast^^Move message pointer to last item in group. ^0" +s[781] = "nntpsend.TNNTPSend.GotoNext^nntpsend.TNNTPSend.html#GotoNext^^Move message pointer to next item in group. ^0" +s[782] = "nntpsend.TNNTPSend.ListGroups^nntpsend.TNNTPSend.html#ListGroups^^Download to Data property list of all groups on NNTP server. ^0" +s[783] = "nntpsend.TNNTPSend.ListNewGroups^nntpsend.TNNTPSend.html#ListNewGroups^^Download to Data property list of all groups created after given time. ^0" +s[784] = "nntpsend.TNNTPSend.NewArticles^nntpsend.TNNTPSend.html#NewArticles^^Download to Data property list of message-ids in given group since given time. ^0" +s[785] = "nntpsend.TNNTPSend.PostArticle^nntpsend.TNNTPSend.html#PostArticle^^Upload new article to server. (for new messages by you) ^0" +s[786] = "nntpsend.TNNTPSend.SwitchToSlave^nntpsend.TNNTPSend.html#SwitchToSlave^^Tells to remote NNTP server 'I am not NNTP client, but I am another NNTP server'. ^0" +s[787] = "nntpsend.TNNTPSend.Xover^nntpsend.TNNTPSend.html#Xover^^Call NNTP XOVER command. ^0" +s[788] = "nntpsend.TNNTPSend.StartTLS^nntpsend.TNNTPSend.html#StartTLS^^Call STARTTLS command for upgrade connection to SSL/TLS mode. ^0" +s[789] = "nntpsend.TNNTPSend.FindCap^nntpsend.TNNTPSend.html#FindCap^^Try to find given capability in extension list. This list is getted after successful login to NNTP server. If extension capability is not found, then return is empty string. ^0" +s[790] = "nntpsend.TNNTPSend.ListExtensions^nntpsend.TNNTPSend.html#ListExtensions^^Try get list of server extensions. List is returned in Data property. ^0" +s[791] = "nntpsend.TNNTPSend.ResultCode^nntpsend.TNNTPSend.html#ResultCode^^Result code number of last operation. ^0" +s[792] = "nntpsend.TNNTPSend.ResultString^nntpsend.TNNTPSend.html#ResultString^^String description of last result code from NNTP server. ^0" +s[793] = "nntpsend.TNNTPSend.Data^nntpsend.TNNTPSend.html#Data^^Readed data. (message, etc.) ^0" +s[794] = "nntpsend.TNNTPSend.AutoTLS^nntpsend.TNNTPSend.html#AutoTLS^^If is set to True, then upgrade to SSL/TLS mode after login if remote server support it. ^0" +s[795] = "nntpsend.TNNTPSend.FullSSL^nntpsend.TNNTPSend.html#FullSSL^^SSL/TLS mode is used from first contact to server. Servers with full SSL/TLS mode usualy using non-standard TCP port! ^0" +s[796] = "nntpsend.TNNTPSend.Sock^nntpsend.TNNTPSend.html#Sock^^Socket object used for TCP/IP operation. Good for seting OnStatus hook, etc. ^0" +s[797] = "nntpsend.cNNTPProtocol^nntpsend.html#cNNTPProtocol^^ ^0" +s[798] = "pingsend^pingsend.html^^ ^0" +s[799] = "pingsend.TPINGSend^pingsend.TPINGSend.html^Implementation of ICMP PING and ICMPv6 PING.^ ^0" +s[800] = "pingsend.TPINGSend.Ping^pingsend.TPINGSend.html#Ping^^Send ICMP ping to host and count PingTime. If ping OK, result is True. ^0" +s[801] = "pingsend.TPINGSend.Create^pingsend.TPINGSend.html#Create^^ ^0" +s[802] = "pingsend.TPINGSend.Destroy^pingsend.TPINGSend.html#Destroy^^ ^0" +s[803] = "pingsend.TPINGSend.PacketSize^pingsend.TPINGSend.html#PacketSize^^Size of PING packet. Default size is 32 bytes. ^0" +s[804] = "pingsend.TPINGSend.PingTime^pingsend.TPINGSend.html#PingTime^^Time between request and reply. ^0" +s[805] = "pingsend.TPINGSend.ReplyFrom^pingsend.TPINGSend.html#ReplyFrom^^From this address is sended reply for your PING request. It maybe not your requested destination, when some error occured! ^0" +s[806] = "pingsend.TPINGSend.ReplyType^pingsend.TPINGSend.html#ReplyType^^ICMP type of PING reply. Each protocol using another values! For IPv4 and IPv6 are used different values! ^0" +s[807] = "pingsend.TPINGSend.ReplyCode^pingsend.TPINGSend.html#ReplyCode^^ICMP code of PING reply. Each protocol using another values! For IPv4 and IPv6 are used different values! For protocol independent value look to ReplyError ^0" +s[808] = "pingsend.TPINGSend.ReplyError^pingsend.TPINGSend.html#ReplyError^^Return type of returned ICMP message. This value is independent on used protocol! ^0" +s[809] = "pingsend.TPINGSend.ReplyErrorDesc^pingsend.TPINGSend.html#ReplyErrorDesc^^Return human readable description of returned packet type. ^0" +s[810] = "pingsend.TPINGSend.Sock^pingsend.TPINGSend.html#Sock^^Socket object used for TCP/IP operation. Good for seting OnStatus hook, etc. ^0" +s[811] = "pingsend.TPINGSend.TTL^pingsend.TPINGSend.html#TTL^^TTL value for ICMP query ^0" +s[812] = "pingsend.ICMP_ECHO^pingsend.html#ICMP_ECHO^^ ^0" +s[813] = "pingsend.ICMP_ECHOREPLY^pingsend.html#ICMP_ECHOREPLY^^ ^0" +s[814] = "pingsend.ICMP_UNREACH^pingsend.html#ICMP_UNREACH^^ ^0" +s[815] = "pingsend.ICMP_TIME_EXCEEDED^pingsend.html#ICMP_TIME_EXCEEDED^^ ^0" +s[816] = "pingsend.ICMP6_ECHO^pingsend.html#ICMP6_ECHO^^ ^0" +s[817] = "pingsend.ICMP6_ECHOREPLY^pingsend.html#ICMP6_ECHOREPLY^^ ^0" +s[818] = "pingsend.ICMP6_UNREACH^pingsend.html#ICMP6_UNREACH^^ ^0" +s[819] = "pingsend.ICMP6_TIME_EXCEEDED^pingsend.html#ICMP6_TIME_EXCEEDED^^ ^0" +s[820] = "pingsend.PingHost^pingsend.html#PingHost^^A very useful function and example of its use would be found in the TPINGSend object. Use it to ping to any host. If successful, returns the ping time in milliseconds. Returns -1 if an error occurred. ^0" +s[821] = "pingsend.TraceRouteHost^pingsend.html#TraceRouteHost^^A very useful function and example of its use would be found in the TPINGSend object. Use it to TraceRoute to any host. ^0" +s[822] = "pingsend.TICMPError^pingsend.html#TICMPError^^List of possible ICMP reply packet types. IE_NoError IE_Other IE_TTLExceed IE_UnreachOther IE_UnreachRoute IE_UnreachAdmin IE_UnreachAddr IE_UnreachPort ^0" +s[823] = "pop3send^pop3send.html^POP3 protocol client^

Used RFC: RFC-1734, RFC-1939, RFC-2195, RFC-2449, RFC-2595 ^0" +s[824] = "pop3send.TPOP3Send^pop3send.TPOP3Send.html^Implementation of POP3 client protocol.^

Note: Are you missing properties for setting Username and Password? Look to parent TSynaClient object!

Are you missing properties for specify server address and port? Look to parent TSynaClient too! ^0" +s[825] = "pop3send.TPOP3Send.Create^pop3send.TPOP3Send.html#Create^^ ^0" +s[826] = "pop3send.TPOP3Send.Destroy^pop3send.TPOP3Send.html#Destroy^^ ^0" +s[827] = "pop3send.TPOP3Send.CustomCommand^pop3send.TPOP3Send.html#CustomCommand^^You can call any custom by this method. Call Command without trailing CRLF. If MultiLine parameter is True, multilined response are expected. Result is True on sucess. ^0" +s[828] = "pop3send.TPOP3Send.Capability^pop3send.TPOP3Send.html#Capability^^Call CAPA command for get POP3 server capabilites. note: not all servers support this command! ^0" +s[829] = "pop3send.TPOP3Send.Login^pop3send.TPOP3Send.html#Login^^Connect to remote POP3 host. If all OK, result is True. ^0" +s[830] = "pop3send.TPOP3Send.Logout^pop3send.TPOP3Send.html#Logout^^Disconnects from POP3 server. ^0" +s[831] = "pop3send.TPOP3Send.Reset^pop3send.TPOP3Send.html#Reset^^Send RSET command. If all OK, result is True. ^0" +s[832] = "pop3send.TPOP3Send.NoOp^pop3send.TPOP3Send.html#NoOp^^Send NOOP command. If all OK, result is True. ^0" +s[833] = "pop3send.TPOP3Send.Stat^pop3send.TPOP3Send.html#Stat^^Send STAT command and fill StatCount and StatSize property. If all OK, result is True. ^0" +s[834] = "pop3send.TPOP3Send.List^pop3send.TPOP3Send.html#List^^Send LIST command. If Value is 0, LIST is for all messages. After successful operation is listing in FullResult. If all OK, result is True. ^0" +s[835] = "pop3send.TPOP3Send.Retr^pop3send.TPOP3Send.html#Retr^^Send RETR command. After successful operation dowloaded message in FullResult. If all OK, result is True. ^0" +s[836] = "pop3send.TPOP3Send.RetrStream^pop3send.TPOP3Send.html#RetrStream^^Send RETR command. After successful operation dowloaded message in Stream. If all OK, result is True. ^0" +s[837] = "pop3send.TPOP3Send.Dele^pop3send.TPOP3Send.html#Dele^^Send DELE command for delete specified message. If all OK, result is True. ^0" +s[838] = "pop3send.TPOP3Send.Top^pop3send.TPOP3Send.html#Top^^Send TOP command. After successful operation dowloaded headers of message and maxlines count of message in FullResult. If all OK, result is True. ^0" +s[839] = "pop3send.TPOP3Send.Uidl^pop3send.TPOP3Send.html#Uidl^^Send UIDL command. If Value is 0, UIDL is for all messages. After successful operation is listing in FullResult. If all OK, result is True. ^0" +s[840] = "pop3send.TPOP3Send.StartTLS^pop3send.TPOP3Send.html#StartTLS^^Call STLS command for upgrade connection to SSL/TLS mode. ^0" +s[841] = "pop3send.TPOP3Send.FindCap^pop3send.TPOP3Send.html#FindCap^^Try to find given capabily in capabilty string returned from POP3 server by CAPA command. ^0" +s[842] = "pop3send.TPOP3Send.ResultCode^pop3send.TPOP3Send.html#ResultCode^^Result code of last POP3 operation. 0 - error, 1 - OK. ^0" +s[843] = "pop3send.TPOP3Send.ResultString^pop3send.TPOP3Send.html#ResultString^^Result string of last POP3 operation. ^0" +s[844] = "pop3send.TPOP3Send.FullResult^pop3send.TPOP3Send.html#FullResult^^Stringlist with full lines returned as result of POP3 operation. I.e. if operation is LIST, this property is filled by list of messages. If operation is RETR, this property have downloaded message. ^0" +s[845] = "pop3send.TPOP3Send.StatCount^pop3send.TPOP3Send.html#StatCount^^After STAT command is there count of messages in inbox. ^0" +s[846] = "pop3send.TPOP3Send.StatSize^pop3send.TPOP3Send.html#StatSize^^After STAT command is there size of all messages in inbox. ^0" +s[847] = "pop3send.TPOP3Send.ListSize^pop3send.TPOP3Send.html#ListSize^^After LIST 0 command size of all messages on server, After LIST x size of message x on server ^0" +s[848] = "pop3send.TPOP3Send.TimeStamp^pop3send.TPOP3Send.html#TimeStamp^^If server support this, after comnnect is in this property timestamp of remote server. ^0" +s[849] = "pop3send.TPOP3Send.AuthType^pop3send.TPOP3Send.html#AuthType^^Type of authorisation for login to POP3 server. Dafault is autodetect one of possible authorisation. Autodetect do this:

If remote POP3 server support APOP, try login by APOP method. If APOP is not supported, or if APOP login failed, try classic USER+PASS login method. ^0" +s[850] = "pop3send.TPOP3Send.AutoTLS^pop3send.TPOP3Send.html#AutoTLS^^If is set to True, then upgrade to SSL/TLS mode if remote server support it. ^0" +s[851] = "pop3send.TPOP3Send.FullSSL^pop3send.TPOP3Send.html#FullSSL^^SSL/TLS mode is used from first contact to server. Servers with full SSL/TLS mode usualy using non-standard TCP port! ^0" +s[852] = "pop3send.TPOP3Send.Sock^pop3send.TPOP3Send.html#Sock^^Socket object used for TCP/IP operation. Good for seting OnStatus hook, etc. ^0" +s[853] = "pop3send.cPop3Protocol^pop3send.html#cPop3Protocol^^ ^0" +s[854] = "pop3send.TPOP3AuthType^pop3send.html#TPOP3AuthType^^The three types of possible authorization methods for "logging in" to a POP3 server. POP3AuthAll POP3AuthLogin POP3AuthAPOP ^0" +s[855] = "slogsend^slogsend.html^BSD SYSLOG protocol^

Used RFC: RFC-3164 ^0" +s[856] = "slogsend.TSyslogMessage^slogsend.TSyslogMessage.html^encoding or decoding of SYSLOG message^ ^0" +s[857] = "slogsend.TSyslogMessage.Clear^slogsend.TSyslogMessage.html#Clear^^Reset values to defaults ^0" +s[858] = "slogsend.TSyslogMessage.Facility^slogsend.TSyslogMessage.html#Facility^^Define facilicity of Syslog message. For specify you may use predefined FCL_* constants. Default is "FCL_Local0". ^0" +s[859] = "slogsend.TSyslogMessage.Severity^slogsend.TSyslogMessage.html#Severity^^Define possible priority of Syslog message. Default is "Debug". ^0" +s[860] = "slogsend.TSyslogMessage.DateTime^slogsend.TSyslogMessage.html#DateTime^^date and time of Syslog message ^0" +s[861] = "slogsend.TSyslogMessage.Tag^slogsend.TSyslogMessage.html#Tag^^This is used for identify process of this message. Default is filename of your executable file. ^0" +s[862] = "slogsend.TSyslogMessage.LogMessage^slogsend.TSyslogMessage.html#LogMessage^^Text of your message for log. ^0" +s[863] = "slogsend.TSyslogMessage.LocalIP^slogsend.TSyslogMessage.html#LocalIP^^IP address of message sender. ^0" +s[864] = "slogsend.TSyslogMessage.PacketBuf^slogsend.TSyslogMessage.html#PacketBuf^^This property holds encoded binary SYSLOG packet ^0" +s[865] = "slogsend.TSyslogSend^slogsend.TSyslogSend.html^This object implement BSD SysLog client^

Note: Are you missing properties for specify server address and port? Look to parent TSynaClient too! ^0" +s[866] = "slogsend.TSyslogSend.Create^slogsend.TSyslogSend.html#Create^^ ^0" +s[867] = "slogsend.TSyslogSend.Destroy^slogsend.TSyslogSend.html#Destroy^^ ^0" +s[868] = "slogsend.TSyslogSend.DoIt^slogsend.TSyslogSend.html#DoIt^^Send Syslog UDP packet defined by SysLogMessage. ^0" +s[869] = "slogsend.TSyslogSend.SysLogMessage^slogsend.TSyslogSend.html#SysLogMessage^^Syslog message for send ^0" +s[870] = "slogsend.cSysLogProtocol^slogsend.html#cSysLogProtocol^^ ^0" +s[871] = "slogsend.FCL_Kernel^slogsend.html#FCL_Kernel^^ ^0" +s[872] = "slogsend.FCL_UserLevel^slogsend.html#FCL_UserLevel^^ ^0" +s[873] = "slogsend.FCL_MailSystem^slogsend.html#FCL_MailSystem^^ ^0" +s[874] = "slogsend.FCL_System^slogsend.html#FCL_System^^ ^0" +s[875] = "slogsend.FCL_Security^slogsend.html#FCL_Security^^ ^0" +s[876] = "slogsend.FCL_Syslogd^slogsend.html#FCL_Syslogd^^ ^0" +s[877] = "slogsend.FCL_Printer^slogsend.html#FCL_Printer^^ ^0" +s[878] = "slogsend.FCL_News^slogsend.html#FCL_News^^ ^0" +s[879] = "slogsend.FCL_UUCP^slogsend.html#FCL_UUCP^^ ^0" +s[880] = "slogsend.FCL_Clock^slogsend.html#FCL_Clock^^ ^0" +s[881] = "slogsend.FCL_Authorization^slogsend.html#FCL_Authorization^^ ^0" +s[882] = "slogsend.FCL_FTP^slogsend.html#FCL_FTP^^ ^0" +s[883] = "slogsend.FCL_NTP^slogsend.html#FCL_NTP^^ ^0" +s[884] = "slogsend.FCL_LogAudit^slogsend.html#FCL_LogAudit^^ ^0" +s[885] = "slogsend.FCL_LogAlert^slogsend.html#FCL_LogAlert^^ ^0" +s[886] = "slogsend.FCL_Time^slogsend.html#FCL_Time^^ ^0" +s[887] = "slogsend.FCL_Local0^slogsend.html#FCL_Local0^^ ^0" +s[888] = "slogsend.FCL_Local1^slogsend.html#FCL_Local1^^ ^0" +s[889] = "slogsend.FCL_Local2^slogsend.html#FCL_Local2^^ ^0" +s[890] = "slogsend.FCL_Local3^slogsend.html#FCL_Local3^^ ^0" +s[891] = "slogsend.FCL_Local4^slogsend.html#FCL_Local4^^ ^0" +s[892] = "slogsend.FCL_Local5^slogsend.html#FCL_Local5^^ ^0" +s[893] = "slogsend.FCL_Local6^slogsend.html#FCL_Local6^^ ^0" +s[894] = "slogsend.FCL_Local7^slogsend.html#FCL_Local7^^ ^0" +s[895] = "slogsend.ToSysLog^slogsend.html#ToSysLog^^Simply send packet to specified Syslog server. ^0" +s[896] = "slogsend.TSyslogSeverity^slogsend.html#TSyslogSeverity^Define possible priority of Syslog message^ Emergency Alert Critical Error Warning Notice Info Debug ^0" +s[897] = "smtpsend^smtpsend.html^SMTP client^

Used RFC: RFC-1869, RFC-1870, RFC-1893, RFC-2034, RFC-2104, RFC-2195, RFC-2487, RFC-2554, RFC-2821 ^0" +s[898] = "smtpsend.TSMTPSend^smtpsend.TSMTPSend.html^Implementation of SMTP and ESMTP procotol^, include some ESMTP extensions, include SSL/TLS too.

Note: Are you missing properties for setting Username and Password for ESMTP? Look to parent TSynaClient object!

Are you missing properties for specify server address and port? Look to parent TSynaClient too! ^0" +s[899] = "smtpsend.TSMTPSend.Create^smtpsend.TSMTPSend.html#Create^^ ^0" +s[900] = "smtpsend.TSMTPSend.Destroy^smtpsend.TSMTPSend.html#Destroy^^ ^0" +s[901] = "smtpsend.TSMTPSend.Login^smtpsend.TSMTPSend.html#Login^^Connects to SMTP server (defined in TSynaClient.TargetHost) and begin SMTP session. (First try ESMTP EHLO, next old HELO handshake). Parses ESMTP capabilites and if you specified Username and password and remote server can handle AUTH command, try login by AUTH command. Preffered login method is CRAM-MD5 (if safer!). If all OK, result is True, else result is False. ^0" +s[902] = "smtpsend.TSMTPSend.Logout^smtpsend.TSMTPSend.html#Logout^^Close SMTP session (QUIT command) and disconnect from SMTP server. ^0" +s[903] = "smtpsend.TSMTPSend.Reset^smtpsend.TSMTPSend.html#Reset^^Send RSET SMTP command for reset SMTP session. If all OK, result is True, else result is False. ^0" +s[904] = "smtpsend.TSMTPSend.NoOp^smtpsend.TSMTPSend.html#NoOp^^Send NOOP SMTP command for keep SMTP session. If all OK, result is True, else result is False. ^0" +s[905] = "smtpsend.TSMTPSend.MailFrom^smtpsend.TSMTPSend.html#MailFrom^^Send MAIL FROM SMTP command for set sender e-mail address. If sender's e-mail address is empty string, transmited message is error message.

If size not 0 and remote server can handle SIZE parameter, append SIZE parameter to request. If all OK, result is True, else result is False. ^0" +s[906] = "smtpsend.TSMTPSend.MailTo^smtpsend.TSMTPSend.html#MailTo^^Send RCPT TO SMTP command for set receiver e-mail address. It cannot be an empty string. If all OK, result is True, else result is False. ^0" +s[907] = "smtpsend.TSMTPSend.MailData^smtpsend.TSMTPSend.html#MailData^^Send DATA SMTP command and transmit message data. If all OK, result is True, else result is False. ^0" +s[908] = "smtpsend.TSMTPSend.Etrn^smtpsend.TSMTPSend.html#Etrn^^Send ETRN SMTP command for start sending of remote queue for domain in Value. If all OK, result is True, else result is False. ^0" +s[909] = "smtpsend.TSMTPSend.Verify^smtpsend.TSMTPSend.html#Verify^^Send VRFY SMTP command for check receiver e-mail address. It cannot be an empty string. If all OK, result is True, else result is False. ^0" +s[910] = "smtpsend.TSMTPSend.StartTLS^smtpsend.TSMTPSend.html#StartTLS^^Call STARTTLS command for upgrade connection to SSL/TLS mode. ^0" +s[911] = "smtpsend.TSMTPSend.EnhCodeString^smtpsend.TSMTPSend.html#EnhCodeString^^Return string descriptive text for enhanced result codes stored in EnhCode1, EnhCode2 and EnhCode3. ^0" +s[912] = "smtpsend.TSMTPSend.FindCap^smtpsend.TSMTPSend.html#FindCap^^Try to find specified capability in ESMTP response. ^0" +s[913] = "smtpsend.TSMTPSend.ResultCode^smtpsend.TSMTPSend.html#ResultCode^^result code of last SMTP command. ^0" +s[914] = "smtpsend.TSMTPSend.ResultString^smtpsend.TSMTPSend.html#ResultString^^result string of last SMTP command (begin with string representation of result code). ^0" +s[915] = "smtpsend.TSMTPSend.FullResult^smtpsend.TSMTPSend.html#FullResult^^All result strings of last SMTP command (result is maybe multiline!). ^0" +s[916] = "smtpsend.TSMTPSend.ESMTPcap^smtpsend.TSMTPSend.html#ESMTPcap^^List of ESMTP capabilites of remote ESMTP server. (If you connect to ESMTP server only!). ^0" +s[917] = "smtpsend.TSMTPSend.ESMTP^smtpsend.TSMTPSend.html#ESMTP^^True if you successfuly logged to ESMTP server. ^0" +s[918] = "smtpsend.TSMTPSend.AuthDone^smtpsend.TSMTPSend.html#AuthDone^^True if you successfuly pass authorisation to remote server. ^0" +s[919] = "smtpsend.TSMTPSend.ESMTPSize^smtpsend.TSMTPSend.html#ESMTPSize^^True if remote server can handle SIZE parameter. ^0" +s[920] = "smtpsend.TSMTPSend.MaxSize^smtpsend.TSMTPSend.html#MaxSize^^When ESMTPSize is True, contains max length of message that remote server can handle. ^0" +s[921] = "smtpsend.TSMTPSend.EnhCode1^smtpsend.TSMTPSend.html#EnhCode1^^First digit of Enhanced result code. If last operation does not have enhanced result code, values is 0. ^0" +s[922] = "smtpsend.TSMTPSend.EnhCode2^smtpsend.TSMTPSend.html#EnhCode2^^Second digit of Enhanced result code. If last operation does not have enhanced result code, values is 0. ^0" +s[923] = "smtpsend.TSMTPSend.EnhCode3^smtpsend.TSMTPSend.html#EnhCode3^^Third digit of Enhanced result code. If last operation does not have enhanced result code, values is 0. ^0" +s[924] = "smtpsend.TSMTPSend.SystemName^smtpsend.TSMTPSend.html#SystemName^^name of our system used in HELO and EHLO command. Implicit value is internet address of your machine. ^0" +s[925] = "smtpsend.TSMTPSend.AutoTLS^smtpsend.TSMTPSend.html#AutoTLS^^If is set to true, then upgrade to SSL/TLS mode if remote server support it. ^0" +s[926] = "smtpsend.TSMTPSend.FullSSL^smtpsend.TSMTPSend.html#FullSSL^^SSL/TLS mode is used from first contact to server. Servers with full SSL/TLS mode usualy using non-standard TCP port! ^0" +s[927] = "smtpsend.TSMTPSend.Sock^smtpsend.TSMTPSend.html#Sock^^Socket object used for TCP/IP operation. Good for seting OnStatus hook, etc. ^0" +s[928] = "smtpsend.cSmtpProtocol^smtpsend.html#cSmtpProtocol^^ ^0" +s[929] = "smtpsend.SendToRaw^smtpsend.html#SendToRaw^^A very useful function and example of its use would be found in the TSMTPsend object. Send maildata (text of e-mail with all SMTP headers! For example when text of message is created by TMimeMess object) from "MailFrom" e-mail address to "MailTo" e-mail address (If you need more then one receiver, then separate their addresses by comma).

If you need use different port number then standard, then add this port number to SMTPhost after colon. (i.e. '127.0.0.1:1025') ^0" +s[930] = "smtpsend.SendTo^smtpsend.html#SendTo^^A very useful function and example of its use would be found in the TSMTPsend object. Send "Maildata" (text of e-mail without any SMTP headers!) from "MailFrom" e-mail address to "MailTo" e-mail address with "Subject". (If you need more then one receiver, then separate their addresses by comma).

If you need use different port number then standard, then add this port number to SMTPhost after colon. (i.e. '127.0.0.1:1025') ^0" +s[931] = "smtpsend.SendToEx^smtpsend.html#SendToEx^^A very useful function and example of its use would be found in the TSMTPsend object. Sends "MailData" (text of e-mail without any SMTP headers!) from "MailFrom" e-mail address to "MailTo" e-mail address (If you need more then one receiver, then separate their addresses by comma).

If you need use different port number then standard, then add this port number to SMTPhost after colon. (i.e. '127.0.0.1:1025') ^0" +s[932] = "snmpsend^snmpsend.html^SNMP client^ Supports SNMPv1 include traps, SNMPv2c and SNMPv3 include authorization and privacy encryption.

Used RFC: RFC-1157, RFC-1901, RFC-3412, RFC-3414, RFC-3416, RFC-3826

Supported Authorization hashes: MD5, SHA1 Supported Privacy encryptions: DES, 3DES, AES ^0" +s[933] = "snmpsend.TSNMPMib^snmpsend.TSNMPMib.html^Data object with one record of MIB OID and corresponding values.^ ^0" +s[934] = "snmpsend.TSNMPMib.OID^snmpsend.TSNMPMib.html#OID^^OID number in string format. ^0" +s[935] = "snmpsend.TSNMPMib.Value^snmpsend.TSNMPMib.html#Value^^Value of OID object in string format. ^0" +s[936] = "snmpsend.TSNMPMib.ValueType^snmpsend.TSNMPMib.html#ValueType^^Define type of Value. Supported values are defined in asn1util. For queries use ASN1_NULL, becouse you don't know type in response! ^0" +s[937] = "snmpsend.TV3Sync^snmpsend.TV3Sync.html^It holding all information for SNMPv3 agent synchronization^ Used internally. ^0" +s[938] = "snmpsend.TV3Sync.EngineID^snmpsend.TV3Sync.html#EngineID^^ ^0" +s[939] = "snmpsend.TV3Sync.EngineBoots^snmpsend.TV3Sync.html#EngineBoots^^ ^0" +s[940] = "snmpsend.TV3Sync.EngineTime^snmpsend.TV3Sync.html#EngineTime^^ ^0" +s[941] = "snmpsend.TV3Sync.EngineStamp^snmpsend.TV3Sync.html#EngineStamp^^ ^0" +s[942] = "snmpsend.TSNMPRec^snmpsend.TSNMPRec.html^Data object abstracts SNMP data packet^ ^0" +s[943] = "snmpsend.TSNMPRec.Create^snmpsend.TSNMPRec.html#Create^^ ^0" +s[944] = "snmpsend.TSNMPRec.Destroy^snmpsend.TSNMPRec.html#Destroy^^ ^0" +s[945] = "snmpsend.TSNMPRec.DecodeBuf^snmpsend.TSNMPRec.html#DecodeBuf^^Decode SNMP packet in buffer to object properties. ^0" +s[946] = "snmpsend.TSNMPRec.EncodeBuf^snmpsend.TSNMPRec.html#EncodeBuf^^Encode obeject properties to SNMP packet. ^0" +s[947] = "snmpsend.TSNMPRec.Clear^snmpsend.TSNMPRec.html#Clear^^Clears all object properties to default values. ^0" +s[948] = "snmpsend.TSNMPRec.MIBAdd^snmpsend.TSNMPRec.html#MIBAdd^^Add entry to SNMPMibList. For queries use value as empty string, and ValueType as ASN1_NULL. ^0" +s[949] = "snmpsend.TSNMPRec.MIBDelete^snmpsend.TSNMPRec.html#MIBDelete^^Delete entry from SNMPMibList. ^0" +s[950] = "snmpsend.TSNMPRec.MIBGet^snmpsend.TSNMPRec.html#MIBGet^^Search SNMPMibList list for MIB and return correspond value. ^0" +s[951] = "snmpsend.TSNMPRec.MIBCount^snmpsend.TSNMPRec.html#MIBCount^^return number of entries in MIB array. ^0" +s[952] = "snmpsend.TSNMPRec.MIBByIndex^snmpsend.TSNMPRec.html#MIBByIndex^^Return MIB information from given row of MIB array. ^0" +s[953] = "snmpsend.TSNMPRec.SNMPMibList^snmpsend.TSNMPRec.html#SNMPMibList^^List of TSNMPMib objects. ^0" +s[954] = "snmpsend.TSNMPRec.Version^snmpsend.TSNMPRec.html#Version^^Version of SNMP packet. Default value is 0 (SNMP ver. 1). You can use value 1 for SNMPv2c or value 3 for SNMPv3. ^0" +s[955] = "snmpsend.TSNMPRec.Community^snmpsend.TSNMPRec.html#Community^^Community string for autorize access to SNMP server. (Case sensitive!) Community string is not used in SNMPv3! Use UserName and Password instead! ^0" +s[956] = "snmpsend.TSNMPRec.PDUType^snmpsend.TSNMPRec.html#PDUType^^Define type of SNMP operation. ^0" +s[957] = "snmpsend.TSNMPRec.ID^snmpsend.TSNMPRec.html#ID^^Contains ID number. Not need to use. ^0" +s[958] = "snmpsend.TSNMPRec.ErrorStatus^snmpsend.TSNMPRec.html#ErrorStatus^^When packet is reply, contains error code. Supported values are defined by E* constants. ^0" +s[959] = "snmpsend.TSNMPRec.ErrorIndex^snmpsend.TSNMPRec.html#ErrorIndex^^Point to error position in reply packet. Not usefull for users. It only good for debugging! ^0" +s[960] = "snmpsend.TSNMPRec.NonRepeaters^snmpsend.TSNMPRec.html#NonRepeaters^^special value for GetBulkRequest of SNMPv2 and v3. ^0" +s[961] = "snmpsend.TSNMPRec.MaxRepetitions^snmpsend.TSNMPRec.html#MaxRepetitions^^special value for GetBulkRequest of SNMPv2 and v3. ^0" +s[962] = "snmpsend.TSNMPRec.MaxSize^snmpsend.TSNMPRec.html#MaxSize^^Maximum message size in bytes for SNMPv3. For sending is default 1472 bytes. ^0" +s[963] = "snmpsend.TSNMPRec.Flags^snmpsend.TSNMPRec.html#Flags^^Specify if message is authorised or encrypted. Used only in SNMPv3. ^0" +s[964] = "snmpsend.TSNMPRec.FlagReportable^snmpsend.TSNMPRec.html#FlagReportable^^For SNMPv3.... If is True, SNMP agent must send reply (at least with some error). ^0" +s[965] = "snmpsend.TSNMPRec.ContextEngineID^snmpsend.TSNMPRec.html#ContextEngineID^^For SNMPv3. If not specified, is used value from AuthEngineID ^0" +s[966] = "snmpsend.TSNMPRec.ContextName^snmpsend.TSNMPRec.html#ContextName^^For SNMPv3. ^0" +s[967] = "snmpsend.TSNMPRec.AuthMode^snmpsend.TSNMPRec.html#AuthMode^^For SNMPv3. Specify Authorization mode. (specify used hash for authorization) ^0" +s[968] = "snmpsend.TSNMPRec.PrivMode^snmpsend.TSNMPRec.html#PrivMode^^For SNMPv3. Specify Privacy mode. ^0" +s[969] = "snmpsend.TSNMPRec.AuthEngineID^snmpsend.TSNMPRec.html#AuthEngineID^^value used by SNMPv3 authorisation for synchronization with SNMP agent. ^0" +s[970] = "snmpsend.TSNMPRec.AuthEngineBoots^snmpsend.TSNMPRec.html#AuthEngineBoots^^value used by SNMPv3 authorisation for synchronization with SNMP agent. ^0" +s[971] = "snmpsend.TSNMPRec.AuthEngineTime^snmpsend.TSNMPRec.html#AuthEngineTime^^value used by SNMPv3 authorisation for synchronization with SNMP agent. ^0" +s[972] = "snmpsend.TSNMPRec.AuthEngineTimeStamp^snmpsend.TSNMPRec.html#AuthEngineTimeStamp^^value used by SNMPv3 authorisation for synchronization with SNMP agent. ^0" +s[973] = "snmpsend.TSNMPRec.UserName^snmpsend.TSNMPRec.html#UserName^^SNMPv3 authorization username ^0" +s[974] = "snmpsend.TSNMPRec.Password^snmpsend.TSNMPRec.html#Password^^SNMPv3 authorization password ^0" +s[975] = "snmpsend.TSNMPRec.AuthKey^snmpsend.TSNMPRec.html#AuthKey^^For SNMPv3. Computed Athorization key from Password. ^0" +s[976] = "snmpsend.TSNMPRec.PrivPassword^snmpsend.TSNMPRec.html#PrivPassword^^SNMPv3 privacy password ^0" +s[977] = "snmpsend.TSNMPRec.PrivKey^snmpsend.TSNMPRec.html#PrivKey^^For SNMPv3. Computed Privacy key from PrivPassword. ^0" +s[978] = "snmpsend.TSNMPRec.OldTrapEnterprise^snmpsend.TSNMPRec.html#OldTrapEnterprise^^MIB value to identify the object that sent the TRAPv1. ^0" +s[979] = "snmpsend.TSNMPRec.OldTrapHost^snmpsend.TSNMPRec.html#OldTrapHost^^Address of TRAPv1 sender (IP address). ^0" +s[980] = "snmpsend.TSNMPRec.OldTrapGen^snmpsend.TSNMPRec.html#OldTrapGen^^Generic TRAPv1 identification. ^0" +s[981] = "snmpsend.TSNMPRec.OldTrapSpec^snmpsend.TSNMPRec.html#OldTrapSpec^^Specific TRAPv1 identification. ^0" +s[982] = "snmpsend.TSNMPRec.OldTrapTimeTicks^snmpsend.TSNMPRec.html#OldTrapTimeTicks^^Number of 1/100th of seconds since last reboot or power up. (for TRAPv1) ^0" +s[983] = "snmpsend.TSNMPSend^snmpsend.TSNMPSend.html^Implementation of SNMP protocol.^

Note: Are you missing properties for specify server address and port? Look to parent TSynaClient too! ^0" +s[984] = "snmpsend.TSNMPSend.Create^snmpsend.TSNMPSend.html#Create^^ ^0" +s[985] = "snmpsend.TSNMPSend.Destroy^snmpsend.TSNMPSend.html#Destroy^^ ^0" +s[986] = "snmpsend.TSNMPSend.SendRequest^snmpsend.TSNMPSend.html#SendRequest^^Connects to a Host and send there query. If in timeout SNMP server send back query, result is True. If is used SNMPv3, then it synchronize self with SNMPv3 agent first. (It is needed for SNMPv3 auhorization!) ^0" +s[987] = "snmpsend.TSNMPSend.SendTrap^snmpsend.TSNMPSend.html#SendTrap^^Send SNMP packet only, but not waits for reply. Good for sending traps. ^0" +s[988] = "snmpsend.TSNMPSend.RecvTrap^snmpsend.TSNMPSend.html#RecvTrap^^Receive SNMP packet only. Good for receiving traps. ^0" +s[989] = "snmpsend.TSNMPSend.DoIt^snmpsend.TSNMPSend.html#DoIt^^Mapped to SendRequest internally. This function is only for backward compatibility. ^0" +s[990] = "snmpsend.TSNMPSend.Buffer^snmpsend.TSNMPSend.html#Buffer^^contains raw binary form of SNMP packet. Good for debugging. ^0" +s[991] = "snmpsend.TSNMPSend.HostIP^snmpsend.TSNMPSend.html#HostIP^^After SNMP operation hold IP address of remote side. ^0" +s[992] = "snmpsend.TSNMPSend.Query^snmpsend.TSNMPSend.html#Query^^Data object contains SNMP query. ^0" +s[993] = "snmpsend.TSNMPSend.Reply^snmpsend.TSNMPSend.html#Reply^^Data object contains SNMP reply. ^0" +s[994] = "snmpsend.TSNMPSend.Sock^snmpsend.TSNMPSend.html#Sock^^Socket object used for TCP/IP operation. Good for seting OnStatus hook, etc. ^0" +s[995] = "snmpsend.cSnmpProtocol^snmpsend.html#cSnmpProtocol^^ ^0" +s[996] = "snmpsend.cSnmpTrapProtocol^snmpsend.html#cSnmpTrapProtocol^^ ^0" +s[997] = "snmpsend.SNMP_V1^snmpsend.html#SNMP_V1^^ ^0" +s[998] = "snmpsend.SNMP_V2C^snmpsend.html#SNMP_V2C^^ ^0" +s[999] = "snmpsend.SNMP_V3^snmpsend.html#SNMP_V3^^ ^0" +s[1000] = "snmpsend.PDUGetRequest^snmpsend.html#PDUGetRequest^^ ^0" +s[1001] = "snmpsend.PDUGetNextRequest^snmpsend.html#PDUGetNextRequest^^ ^0" +s[1002] = "snmpsend.PDUGetResponse^snmpsend.html#PDUGetResponse^^ ^0" +s[1003] = "snmpsend.PDUSetRequest^snmpsend.html#PDUSetRequest^^ ^0" +s[1004] = "snmpsend.PDUTrap^snmpsend.html#PDUTrap^^ ^0" +s[1005] = "snmpsend.PDUGetBulkRequest^snmpsend.html#PDUGetBulkRequest^^ ^0" +s[1006] = "snmpsend.PDUInformRequest^snmpsend.html#PDUInformRequest^^ ^0" +s[1007] = "snmpsend.PDUTrapV2^snmpsend.html#PDUTrapV2^^ ^0" +s[1008] = "snmpsend.PDUReport^snmpsend.html#PDUReport^^ ^0" +s[1009] = "snmpsend.ENoError^snmpsend.html#ENoError^^ ^0" +s[1010] = "snmpsend.ETooBig^snmpsend.html#ETooBig^^ ^0" +s[1011] = "snmpsend.ENoSuchName^snmpsend.html#ENoSuchName^^ ^0" +s[1012] = "snmpsend.EBadValue^snmpsend.html#EBadValue^^ ^0" +s[1013] = "snmpsend.EReadOnly^snmpsend.html#EReadOnly^^ ^0" +s[1014] = "snmpsend.EGenErr^snmpsend.html#EGenErr^^ ^0" +s[1015] = "snmpsend.ENoAccess^snmpsend.html#ENoAccess^^ ^0" +s[1016] = "snmpsend.EWrongType^snmpsend.html#EWrongType^^ ^0" +s[1017] = "snmpsend.EWrongLength^snmpsend.html#EWrongLength^^ ^0" +s[1018] = "snmpsend.EWrongEncoding^snmpsend.html#EWrongEncoding^^ ^0" +s[1019] = "snmpsend.EWrongValue^snmpsend.html#EWrongValue^^ ^0" +s[1020] = "snmpsend.ENoCreation^snmpsend.html#ENoCreation^^ ^0" +s[1021] = "snmpsend.EInconsistentValue^snmpsend.html#EInconsistentValue^^ ^0" +s[1022] = "snmpsend.EResourceUnavailable^snmpsend.html#EResourceUnavailable^^ ^0" +s[1023] = "snmpsend.ECommitFailed^snmpsend.html#ECommitFailed^^ ^0" +s[1024] = "snmpsend.EUndoFailed^snmpsend.html#EUndoFailed^^ ^0" +s[1025] = "snmpsend.EAuthorizationError^snmpsend.html#EAuthorizationError^^ ^0" +s[1026] = "snmpsend.ENotWritable^snmpsend.html#ENotWritable^^ ^0" +s[1027] = "snmpsend.EInconsistentName^snmpsend.html#EInconsistentName^^ ^0" +s[1028] = "snmpsend.SNMPGet^snmpsend.html#SNMPGet^^A very useful function and example of its use would be found in the TSNMPSend object. It implements basic GET method of the SNMP protocol. The MIB value is located in the "OID" variable, and is sent to the requested "SNMPHost" with the proper "Community" access identifier. Upon a successful retrieval, "Value" will contain the information requested. If the SNMP operation is successful, the result returns True. ^0" +s[1029] = "snmpsend.SNMPSet^snmpsend.html#SNMPSet^^This is useful function and example of use TSNMPSend object. It implements the basic SET method of the SNMP protocol. If the SNMP operation is successful, the result is True. "Value" is value of MIB Oid for "SNMPHost" with "Community" access identifier. You must specify "ValueType" too. ^0" +s[1030] = "snmpsend.SNMPGetNext^snmpsend.html#SNMPGetNext^^A very useful function and example of its use would be found in the TSNMPSend object. It implements basic GETNEXT method of the SNMP protocol. The MIB value is located in the "OID" variable, and is sent to the requested "SNMPHost" with the proper "Community" access identifier. Upon a successful retrieval, "Value" will contain the information requested. If the SNMP operation is successful, the result returns True. ^0" +s[1031] = "snmpsend.SNMPGetTable^snmpsend.html#SNMPGetTable^^A very useful function and example of its use would be found in the TSNMPSend object. It implements basic read of SNMP MIB tables. As BaseOID you must specify basic MIB OID of requested table (base IOD is OID without row and column specificator!) Table is readed into stringlist, where each string is comma delimited string.

Warning: this function is not have best performance. For better performance you must write your own function. best performace you can get by knowledge of structuture of table and by more then one MIB on one query. ^0" +s[1032] = "snmpsend.SNMPGetTableElement^snmpsend.html#SNMPGetTableElement^^A very useful function and example of its use would be found in the TSNMPSend object. It implements basic read of SNMP MIB table element. As BaseOID you must specify basic MIB OID of requested table (base IOD is OID without row and column specificator!) As next you must specify identificator of row and column for specify of needed field of table. ^0" +s[1033] = "snmpsend.SendTrap^snmpsend.html#SendTrap^^A very useful function and example of its use would be found in the TSNMPSend object. It implements a TRAPv1 to send with all data in the parameters. ^0" +s[1034] = "snmpsend.RecvTrap^snmpsend.html#RecvTrap^^A very useful function and example of its use would be found in the TSNMPSend object. It receives a TRAPv1 and returns all the data that comes with it. ^0" +s[1035] = "snmpsend.TV3Flags^snmpsend.html#TV3Flags^Possible values for SNMPv3 flags.^ This flags specify level of authorization and encryption. NoAuthNoPriv AuthNoPriv AuthPriv ^0" +s[1036] = "snmpsend.TV3Auth^snmpsend.html#TV3Auth^Type of SNMPv3 authorization^ AuthMD5 AuthSHA1 ^0" +s[1037] = "snmpsend.TV3Priv^snmpsend.html#TV3Priv^Type of SNMPv3 privacy^ PrivDES Priv3DES PrivAES ^0" +s[1038] = "sntpsend^sntpsend.html^ NTP and SNTP client^

Used RFC: RFC-1305, RFC-2030 ^0" +s[1039] = "sntpsend.TNtp^sntpsend.TNtp.html^Record containing the NTP packet.^ ^0" +s[1040] = "sntpsend.TNtp.mode^sntpsend.TNtp.html#mode^^ ^0" +s[1041] = "sntpsend.TNtp.stratum^sntpsend.TNtp.html#stratum^^ ^0" +s[1042] = "sntpsend.TNtp.poll^sntpsend.TNtp.html#poll^^ ^0" +s[1043] = "sntpsend.TNtp.Precision^sntpsend.TNtp.html#Precision^^ ^0" +s[1044] = "sntpsend.TNtp.RootDelay^sntpsend.TNtp.html#RootDelay^^ ^0" +s[1045] = "sntpsend.TNtp.RootDisperson^sntpsend.TNtp.html#RootDisperson^^ ^0" +s[1046] = "sntpsend.TNtp.RefID^sntpsend.TNtp.html#RefID^^ ^0" +s[1047] = "sntpsend.TNtp.Ref1^sntpsend.TNtp.html#Ref1^^ ^0" +s[1048] = "sntpsend.TNtp.Ref2^sntpsend.TNtp.html#Ref2^^ ^0" +s[1049] = "sntpsend.TNtp.Org1^sntpsend.TNtp.html#Org1^^ ^0" +s[1050] = "sntpsend.TNtp.Org2^sntpsend.TNtp.html#Org2^^ ^0" +s[1051] = "sntpsend.TNtp.Rcv1^sntpsend.TNtp.html#Rcv1^^ ^0" +s[1052] = "sntpsend.TNtp.Rcv2^sntpsend.TNtp.html#Rcv2^^ ^0" +s[1053] = "sntpsend.TNtp.Xmit1^sntpsend.TNtp.html#Xmit1^^ ^0" +s[1054] = "sntpsend.TNtp.Xmit2^sntpsend.TNtp.html#Xmit2^^ ^0" +s[1055] = "sntpsend.TSNTPSend^sntpsend.TSNTPSend.html^Implementation of NTP and SNTP client protocol^, include time synchronisation. It can send NTP or SNTP time queries, or it can receive NTP broadcasts too.

Note: Are you missing properties for specify server address and port? Look to parent TSynaClient too! ^0" +s[1056] = "sntpsend.TSNTPSend.Create^sntpsend.TSNTPSend.html#Create^^ ^0" +s[1057] = "sntpsend.TSNTPSend.Destroy^sntpsend.TSNTPSend.html#Destroy^^ ^0" +s[1058] = "sntpsend.TSNTPSend.DecodeTs^sntpsend.TSNTPSend.html#DecodeTs^^Decode 128 bit timestamp used in NTP packet to TDateTime type. ^0" +s[1059] = "sntpsend.TSNTPSend.EncodeTs^sntpsend.TSNTPSend.html#EncodeTs^^Decode TDateTime type to 128 bit timestamp used in NTP packet. ^0" +s[1060] = "sntpsend.TSNTPSend.GetSNTP^sntpsend.TSNTPSend.html#GetSNTP^^Send request to TSynaClient.TargetHost and wait for reply. If all is OK, then result is True and NTPReply and NTPTime are valid. ^0" +s[1061] = "sntpsend.TSNTPSend.GetNTP^sntpsend.TSNTPSend.html#GetNTP^^Send request to TSynaClient.TargetHost and wait for reply. If all is OK, then result is True and NTPReply and NTPTime are valid. Result time is after all needed corrections. ^0" +s[1062] = "sntpsend.TSNTPSend.GetBroadcastNTP^sntpsend.TSNTPSend.html#GetBroadcastNTP^^Wait for broadcast NTP packet. If all OK, result is True and NTPReply and NTPTime are valid. ^0" +s[1063] = "sntpsend.TSNTPSend.NTPReply^sntpsend.TSNTPSend.html#NTPReply^^Holds last received NTP packet. ^0" +s[1064] = "sntpsend.TSNTPSend.NTPTime^sntpsend.TSNTPSend.html#NTPTime^^Date and time of remote NTP or SNTP server. (UTC time!!!) ^0" +s[1065] = "sntpsend.TSNTPSend.NTPOffset^sntpsend.TSNTPSend.html#NTPOffset^^Offset between your computer and remote NTP or SNTP server. ^0" +s[1066] = "sntpsend.TSNTPSend.NTPDelay^sntpsend.TSNTPSend.html#NTPDelay^^Delay between your computer and remote NTP or SNTP server. ^0" +s[1067] = "sntpsend.TSNTPSend.MaxSyncDiff^sntpsend.TSNTPSend.html#MaxSyncDiff^^Define allowed maximum difference between your time and remote time for synchronising time. If difference is bigger, your system time is not changed! ^0" +s[1068] = "sntpsend.TSNTPSend.SyncTime^sntpsend.TSNTPSend.html#SyncTime^^If True, after successfull getting time is local computer clock synchronised to given time. For synchronising time you must have proper rights! (Usually Administrator) ^0" +s[1069] = "sntpsend.TSNTPSend.Sock^sntpsend.TSNTPSend.html#Sock^^Socket object used for TCP/IP operation. Good for seting OnStatus hook, etc. ^0" +s[1070] = "sntpsend.cNtpProtocol^sntpsend.html#cNtpProtocol^^ ^0" +s[1071] = "ssl_cryptlib^ssl_cryptlib.html^SSL/SSH plugin for CryptLib^

You can use this plugin for SSHv2 connections too! You must explicitly set TCustomSSL.SSLType to value LT_SSHv2 and set TCustomSSL.Username and TCustomSSL.Password. You can use special SSH channels too, see TCustomSSL. ^0" +s[1072] = "ssl_cryptlib.TSSLCryptLib^ssl_cryptlib.TSSLCryptLib.html^class implementing CryptLib SSL/SSH plugin.^ Instance of this class will be created for each TTCPBlockSocket. You not need to create instance of this class, all is done by Synapse itself! ^0" +s[1073] = "ssl_cryptlib.TSSLCryptLib.Create^ssl_cryptlib.TSSLCryptLib.html#Create^^See TCustomSSL.Create ^0" +s[1074] = "ssl_cryptlib.TSSLCryptLib.Destroy^ssl_cryptlib.TSSLCryptLib.html#Destroy^^ ^0" +s[1075] = "ssl_cryptlib.TSSLCryptLib.SetCertCAFile^ssl_cryptlib.TSSLCryptLib.html#SetCertCAFile^^Load trusted CA's in PEM format ^0" +s[1076] = "ssl_cryptlib.TSSLCryptLib.LibVersion^ssl_cryptlib.TSSLCryptLib.html#LibVersion^^See TCustomSSL.LibVersion ^0" +s[1077] = "ssl_cryptlib.TSSLCryptLib.LibName^ssl_cryptlib.TSSLCryptLib.html#LibName^^See TCustomSSL.LibName ^0" +s[1078] = "ssl_cryptlib.TSSLCryptLib.Assign^ssl_cryptlib.TSSLCryptLib.html#Assign^^See TCustomSSL.Assign ^0" +s[1079] = "ssl_cryptlib.TSSLCryptLib.Connect^ssl_cryptlib.TSSLCryptLib.html#Connect^^See TCustomSSL.Connect and ssl_cryptlib for more details. ^0" +s[1080] = "ssl_cryptlib.TSSLCryptLib.Accept^ssl_cryptlib.TSSLCryptLib.html#Accept^^See TCustomSSL.Accept and ssl_cryptlib for more details. ^0" +s[1081] = "ssl_cryptlib.TSSLCryptLib.Shutdown^ssl_cryptlib.TSSLCryptLib.html#Shutdown^^See TCustomSSL.Shutdown ^0" +s[1082] = "ssl_cryptlib.TSSLCryptLib.BiShutdown^ssl_cryptlib.TSSLCryptLib.html#BiShutdown^^See TCustomSSL.BiShutdown ^0" +s[1083] = "ssl_cryptlib.TSSLCryptLib.SendBuffer^ssl_cryptlib.TSSLCryptLib.html#SendBuffer^^See TCustomSSL.SendBuffer ^0" +s[1084] = "ssl_cryptlib.TSSLCryptLib.RecvBuffer^ssl_cryptlib.TSSLCryptLib.html#RecvBuffer^^See TCustomSSL.RecvBuffer ^0" +s[1085] = "ssl_cryptlib.TSSLCryptLib.WaitingData^ssl_cryptlib.TSSLCryptLib.html#WaitingData^^See TCustomSSL.WaitingData ^0" +s[1086] = "ssl_cryptlib.TSSLCryptLib.GetSSLVersion^ssl_cryptlib.TSSLCryptLib.html#GetSSLVersion^^See TCustomSSL.GetSSLVersion ^0" +s[1087] = "ssl_cryptlib.TSSLCryptLib.GetPeerSubject^ssl_cryptlib.TSSLCryptLib.html#GetPeerSubject^^See TCustomSSL.GetPeerSubject ^0" +s[1088] = "ssl_cryptlib.TSSLCryptLib.GetPeerIssuer^ssl_cryptlib.TSSLCryptLib.html#GetPeerIssuer^^See TCustomSSL.GetPeerIssuer ^0" +s[1089] = "ssl_cryptlib.TSSLCryptLib.GetPeerName^ssl_cryptlib.TSSLCryptLib.html#GetPeerName^^See TCustomSSL.GetPeerName ^0" +s[1090] = "ssl_cryptlib.TSSLCryptLib.GetPeerFingerprint^ssl_cryptlib.TSSLCryptLib.html#GetPeerFingerprint^^See TCustomSSL.GetPeerFingerprint ^0" +s[1091] = "ssl_cryptlib.TSSLCryptLib.GetVerifyCert^ssl_cryptlib.TSSLCryptLib.html#GetVerifyCert^^See TCustomSSL.GetVerifyCert ^0" +s[1092] = "ssl_cryptlib.TSSLCryptLib.PrivateKeyLabel^ssl_cryptlib.TSSLCryptLib.html#PrivateKeyLabel^^name of certificate/key within PKCS#15 file. It can hold more then one certificate/key and each certificate/key must have unique label within one file. ^0" +s[1093] = "ssl_openssl^ssl_openssl.html^SSL plugin for OpenSSL^

OpenSSL libraries are loaded dynamicly - you not need OpenSSl librares even you compile your application with this unit. SSL just not working when you not have OpenSSL libraries.

For handling keys and certificates you can use this properties:

This plugin is capable to create Ad-Hoc certificates. When you start SSL/TLS server without explicitly assigned key and certificate, then this plugin create Ad-Hoc key and certificate for each incomming connection by self. It slowdown accepting of new connections! ^0" +s[1094] = "ssl_openssl.TSSLOpenSSL^ssl_openssl.TSSLOpenSSL.html^class implementing OpenSSL SSL plugin.^ Instance of this class will be created for each TTCPBlockSocket. You not need to create instance of this class, all is done by Synapse itself! ^0" +s[1095] = "ssl_openssl.TSSLOpenSSL.Create^ssl_openssl.TSSLOpenSSL.html#Create^^See TCustomSSL.Create ^0" +s[1096] = "ssl_openssl.TSSLOpenSSL.Destroy^ssl_openssl.TSSLOpenSSL.html#Destroy^^ ^0" +s[1097] = "ssl_openssl.TSSLOpenSSL.LibVersion^ssl_openssl.TSSLOpenSSL.html#LibVersion^^See TCustomSSL.LibVersion ^0" +s[1098] = "ssl_openssl.TSSLOpenSSL.LibName^ssl_openssl.TSSLOpenSSL.html#LibName^^See TCustomSSL.LibName ^0" +s[1099] = "ssl_openssl.TSSLOpenSSL.Connect^ssl_openssl.TSSLOpenSSL.html#Connect^^See TCustomSSL.Connect and ssl_cryptlib for more details. ^0" +s[1100] = "ssl_openssl.TSSLOpenSSL.Accept^ssl_openssl.TSSLOpenSSL.html#Accept^^See TCustomSSL.Accept and ssl_cryptlib for more details. ^0" +s[1101] = "ssl_openssl.TSSLOpenSSL.Shutdown^ssl_openssl.TSSLOpenSSL.html#Shutdown^^See TCustomSSL.Shutdown ^0" +s[1102] = "ssl_openssl.TSSLOpenSSL.BiShutdown^ssl_openssl.TSSLOpenSSL.html#BiShutdown^^See TCustomSSL.BiShutdown ^0" +s[1103] = "ssl_openssl.TSSLOpenSSL.SendBuffer^ssl_openssl.TSSLOpenSSL.html#SendBuffer^^See TCustomSSL.SendBuffer ^0" +s[1104] = "ssl_openssl.TSSLOpenSSL.RecvBuffer^ssl_openssl.TSSLOpenSSL.html#RecvBuffer^^See TCustomSSL.RecvBuffer ^0" +s[1105] = "ssl_openssl.TSSLOpenSSL.WaitingData^ssl_openssl.TSSLOpenSSL.html#WaitingData^^See TCustomSSL.WaitingData ^0" +s[1106] = "ssl_openssl.TSSLOpenSSL.GetSSLVersion^ssl_openssl.TSSLOpenSSL.html#GetSSLVersion^^See TCustomSSL.GetSSLVersion ^0" +s[1107] = "ssl_openssl.TSSLOpenSSL.GetPeerSubject^ssl_openssl.TSSLOpenSSL.html#GetPeerSubject^^See TCustomSSL.GetPeerSubject ^0" +s[1108] = "ssl_openssl.TSSLOpenSSL.GetPeerSerialNo^ssl_openssl.TSSLOpenSSL.html#GetPeerSerialNo^^See TCustomSSL.GetPeerSerialNo ^0" +s[1109] = "ssl_openssl.TSSLOpenSSL.GetPeerIssuer^ssl_openssl.TSSLOpenSSL.html#GetPeerIssuer^^See TCustomSSL.GetPeerIssuer ^0" +s[1110] = "ssl_openssl.TSSLOpenSSL.GetPeerName^ssl_openssl.TSSLOpenSSL.html#GetPeerName^^See TCustomSSL.GetPeerName ^0" +s[1111] = "ssl_openssl.TSSLOpenSSL.GetPeerNameHash^ssl_openssl.TSSLOpenSSL.html#GetPeerNameHash^^See TCustomSSL.GetPeerNameHash ^0" +s[1112] = "ssl_openssl.TSSLOpenSSL.GetPeerFingerprint^ssl_openssl.TSSLOpenSSL.html#GetPeerFingerprint^^See TCustomSSL.GetPeerFingerprint ^0" +s[1113] = "ssl_openssl.TSSLOpenSSL.GetCertInfo^ssl_openssl.TSSLOpenSSL.html#GetCertInfo^^See TCustomSSL.GetCertInfo ^0" +s[1114] = "ssl_openssl.TSSLOpenSSL.GetCipherName^ssl_openssl.TSSLOpenSSL.html#GetCipherName^^See TCustomSSL.GetCipherName ^0" +s[1115] = "ssl_openssl.TSSLOpenSSL.GetCipherBits^ssl_openssl.TSSLOpenSSL.html#GetCipherBits^^See TCustomSSL.GetCipherBits ^0" +s[1116] = "ssl_openssl.TSSLOpenSSL.GetCipherAlgBits^ssl_openssl.TSSLOpenSSL.html#GetCipherAlgBits^^See TCustomSSL.GetCipherAlgBits ^0" +s[1117] = "ssl_openssl.TSSLOpenSSL.GetVerifyCert^ssl_openssl.TSSLOpenSSL.html#GetVerifyCert^^See TCustomSSL.GetVerifyCert ^0" +s[1118] = "ssl_openssl_lib^ssl_openssl_lib.html^OpenSSL support^

This unit is Pascal interface to OpenSSL library (used by ssl_openssl unit). OpenSSL is loaded dynamicly on-demand. If this library is not found in system, requested OpenSSL function just return errorcode. ^0" +s[1119] = "ssl_openssl_lib.des_ks_struct^ssl_openssl_lib.des_ks_struct.html^^ ^0" +s[1120] = "ssl_openssl_lib.des_ks_struct.ks^ssl_openssl_lib.des_ks_struct.html#ks^^ ^0" +s[1121] = "ssl_openssl_lib.des_ks_struct.weak_key^ssl_openssl_lib.des_ks_struct.html#weak_key^^ ^0" +s[1122] = "ssl_openssl_lib.EVP_MAX_MD_SIZE^ssl_openssl_lib.html#EVP_MAX_MD_SIZE^^ ^0" +s[1123] = "ssl_openssl_lib.SSL_ERROR_NONE^ssl_openssl_lib.html#SSL_ERROR_NONE^^ ^0" +s[1124] = "ssl_openssl_lib.SSL_ERROR_SSL^ssl_openssl_lib.html#SSL_ERROR_SSL^^ ^0" +s[1125] = "ssl_openssl_lib.SSL_ERROR_WANT_READ^ssl_openssl_lib.html#SSL_ERROR_WANT_READ^^ ^0" +s[1126] = "ssl_openssl_lib.SSL_ERROR_WANT_WRITE^ssl_openssl_lib.html#SSL_ERROR_WANT_WRITE^^ ^0" +s[1127] = "ssl_openssl_lib.SSL_ERROR_WANT_X509_LOOKUP^ssl_openssl_lib.html#SSL_ERROR_WANT_X509_LOOKUP^^ ^0" +s[1128] = "ssl_openssl_lib.SSL_ERROR_SYSCALL^ssl_openssl_lib.html#SSL_ERROR_SYSCALL^^ ^0" +s[1129] = "ssl_openssl_lib.SSL_ERROR_ZERO_RETURN^ssl_openssl_lib.html#SSL_ERROR_ZERO_RETURN^^ ^0" +s[1130] = "ssl_openssl_lib.SSL_ERROR_WANT_CONNECT^ssl_openssl_lib.html#SSL_ERROR_WANT_CONNECT^^ ^0" +s[1131] = "ssl_openssl_lib.SSL_ERROR_WANT_ACCEPT^ssl_openssl_lib.html#SSL_ERROR_WANT_ACCEPT^^ ^0" +s[1132] = "ssl_openssl_lib.SSL_OP_NO_SSLv2^ssl_openssl_lib.html#SSL_OP_NO_SSLv2^^ ^0" +s[1133] = "ssl_openssl_lib.SSL_OP_NO_SSLv3^ssl_openssl_lib.html#SSL_OP_NO_SSLv3^^ ^0" +s[1134] = "ssl_openssl_lib.SSL_OP_NO_TLSv1^ssl_openssl_lib.html#SSL_OP_NO_TLSv1^^ ^0" +s[1135] = "ssl_openssl_lib.SSL_OP_ALL^ssl_openssl_lib.html#SSL_OP_ALL^^ ^0" +s[1136] = "ssl_openssl_lib.SSL_VERIFY_NONE^ssl_openssl_lib.html#SSL_VERIFY_NONE^^ ^0" +s[1137] = "ssl_openssl_lib.SSL_VERIFY_PEER^ssl_openssl_lib.html#SSL_VERIFY_PEER^^ ^0" +s[1138] = "ssl_openssl_lib.OPENSSL_DES_DECRYPT^ssl_openssl_lib.html#OPENSSL_DES_DECRYPT^^ ^0" +s[1139] = "ssl_openssl_lib.OPENSSL_DES_ENCRYPT^ssl_openssl_lib.html#OPENSSL_DES_ENCRYPT^^ ^0" +s[1140] = "ssl_openssl_lib.X509_V_OK^ssl_openssl_lib.html#X509_V_OK^^ ^0" +s[1141] = "ssl_openssl_lib.X509_V_ILLEGAL^ssl_openssl_lib.html#X509_V_ILLEGAL^^ ^0" +s[1142] = "ssl_openssl_lib.X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT^ssl_openssl_lib.html#X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT^^ ^0" +s[1143] = "ssl_openssl_lib.X509_V_ERR_UNABLE_TO_GET_CRL^ssl_openssl_lib.html#X509_V_ERR_UNABLE_TO_GET_CRL^^ ^0" +s[1144] = "ssl_openssl_lib.X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE^ssl_openssl_lib.html#X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE^^ ^0" +s[1145] = "ssl_openssl_lib.X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE^ssl_openssl_lib.html#X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE^^ ^0" +s[1146] = "ssl_openssl_lib.X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY^ssl_openssl_lib.html#X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY^^ ^0" +s[1147] = "ssl_openssl_lib.X509_V_ERR_CERT_SIGNATURE_FAILURE^ssl_openssl_lib.html#X509_V_ERR_CERT_SIGNATURE_FAILURE^^ ^0" +s[1148] = "ssl_openssl_lib.X509_V_ERR_CRL_SIGNATURE_FAILURE^ssl_openssl_lib.html#X509_V_ERR_CRL_SIGNATURE_FAILURE^^ ^0" +s[1149] = "ssl_openssl_lib.X509_V_ERR_CERT_NOT_YET_VALID^ssl_openssl_lib.html#X509_V_ERR_CERT_NOT_YET_VALID^^ ^0" +s[1150] = "ssl_openssl_lib.X509_V_ERR_CERT_HAS_EXPIRED^ssl_openssl_lib.html#X509_V_ERR_CERT_HAS_EXPIRED^^ ^0" +s[1151] = "ssl_openssl_lib.X509_V_ERR_CRL_NOT_YET_VALID^ssl_openssl_lib.html#X509_V_ERR_CRL_NOT_YET_VALID^^ ^0" +s[1152] = "ssl_openssl_lib.X509_V_ERR_CRL_HAS_EXPIRED^ssl_openssl_lib.html#X509_V_ERR_CRL_HAS_EXPIRED^^ ^0" +s[1153] = "ssl_openssl_lib.X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD^ssl_openssl_lib.html#X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD^^ ^0" +s[1154] = "ssl_openssl_lib.X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD^ssl_openssl_lib.html#X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD^^ ^0" +s[1155] = "ssl_openssl_lib.X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD^ssl_openssl_lib.html#X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD^^ ^0" +s[1156] = "ssl_openssl_lib.X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD^ssl_openssl_lib.html#X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD^^ ^0" +s[1157] = "ssl_openssl_lib.X509_V_ERR_OUT_OF_MEM^ssl_openssl_lib.html#X509_V_ERR_OUT_OF_MEM^^ ^0" +s[1158] = "ssl_openssl_lib.X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT^ssl_openssl_lib.html#X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT^^ ^0" +s[1159] = "ssl_openssl_lib.X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN^ssl_openssl_lib.html#X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN^^ ^0" +s[1160] = "ssl_openssl_lib.X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY^ssl_openssl_lib.html#X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY^^ ^0" +s[1161] = "ssl_openssl_lib.X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE^ssl_openssl_lib.html#X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE^^ ^0" +s[1162] = "ssl_openssl_lib.X509_V_ERR_CERT_CHAIN_TOO_LONG^ssl_openssl_lib.html#X509_V_ERR_CERT_CHAIN_TOO_LONG^^ ^0" +s[1163] = "ssl_openssl_lib.X509_V_ERR_CERT_REVOKED^ssl_openssl_lib.html#X509_V_ERR_CERT_REVOKED^^ ^0" +s[1164] = "ssl_openssl_lib.X509_V_ERR_INVALID_CA^ssl_openssl_lib.html#X509_V_ERR_INVALID_CA^^ ^0" +s[1165] = "ssl_openssl_lib.X509_V_ERR_PATH_LENGTH_EXCEEDED^ssl_openssl_lib.html#X509_V_ERR_PATH_LENGTH_EXCEEDED^^ ^0" +s[1166] = "ssl_openssl_lib.X509_V_ERR_INVALID_PURPOSE^ssl_openssl_lib.html#X509_V_ERR_INVALID_PURPOSE^^ ^0" +s[1167] = "ssl_openssl_lib.X509_V_ERR_CERT_UNTRUSTED^ssl_openssl_lib.html#X509_V_ERR_CERT_UNTRUSTED^^ ^0" +s[1168] = "ssl_openssl_lib.X509_V_ERR_CERT_REJECTED^ssl_openssl_lib.html#X509_V_ERR_CERT_REJECTED^^ ^0" +s[1169] = "ssl_openssl_lib.X509_V_ERR_SUBJECT_ISSUER_MISMATCH^ssl_openssl_lib.html#X509_V_ERR_SUBJECT_ISSUER_MISMATCH^^ ^0" +s[1170] = "ssl_openssl_lib.X509_V_ERR_AKID_SKID_MISMATCH^ssl_openssl_lib.html#X509_V_ERR_AKID_SKID_MISMATCH^^ ^0" +s[1171] = "ssl_openssl_lib.X509_V_ERR_AKID_ISSUER_SERIAL_MISMATCH^ssl_openssl_lib.html#X509_V_ERR_AKID_ISSUER_SERIAL_MISMATCH^^ ^0" +s[1172] = "ssl_openssl_lib.X509_V_ERR_KEYUSAGE_NO_CERTSIGN^ssl_openssl_lib.html#X509_V_ERR_KEYUSAGE_NO_CERTSIGN^^ ^0" +s[1173] = "ssl_openssl_lib.X509_V_ERR_UNABLE_TO_GET_CRL_ISSUER^ssl_openssl_lib.html#X509_V_ERR_UNABLE_TO_GET_CRL_ISSUER^^ ^0" +s[1174] = "ssl_openssl_lib.X509_V_ERR_UNHANDLED_CRITICAL_EXTENSION^ssl_openssl_lib.html#X509_V_ERR_UNHANDLED_CRITICAL_EXTENSION^^ ^0" +s[1175] = "ssl_openssl_lib.X509_V_ERR_APPLICATION_VERIFICATION^ssl_openssl_lib.html#X509_V_ERR_APPLICATION_VERIFICATION^^ ^0" +s[1176] = "ssl_openssl_lib.SSL_FILETYPE_ASN1^ssl_openssl_lib.html#SSL_FILETYPE_ASN1^^ ^0" +s[1177] = "ssl_openssl_lib.SSL_FILETYPE_PEM^ssl_openssl_lib.html#SSL_FILETYPE_PEM^^ ^0" +s[1178] = "ssl_openssl_lib.EVP_PKEY_RSA^ssl_openssl_lib.html#EVP_PKEY_RSA^^ ^0" +s[1179] = "ssl_openssl_lib.SSL_CTRL_SET_TLSEXT_HOSTNAME^ssl_openssl_lib.html#SSL_CTRL_SET_TLSEXT_HOSTNAME^^ ^0" +s[1180] = "ssl_openssl_lib.TLSEXT_NAMETYPE_host_name^ssl_openssl_lib.html#TLSEXT_NAMETYPE_host_name^^ ^0" +s[1181] = "ssl_openssl_lib.SslGetError^ssl_openssl_lib.html#SslGetError^^ ^0" +s[1182] = "ssl_openssl_lib.SslLibraryInit^ssl_openssl_lib.html#SslLibraryInit^^ ^0" +s[1183] = "ssl_openssl_lib.SslLoadErrorStrings^ssl_openssl_lib.html#SslLoadErrorStrings^^ ^0" +s[1184] = "ssl_openssl_lib.SslCtxSetCipherList^ssl_openssl_lib.html#SslCtxSetCipherList^^ ^0" +s[1185] = "ssl_openssl_lib.SslCtxNew^ssl_openssl_lib.html#SslCtxNew^^ ^0" +s[1186] = "ssl_openssl_lib.SslCtxFree^ssl_openssl_lib.html#SslCtxFree^^ ^0" +s[1187] = "ssl_openssl_lib.SslSetFd^ssl_openssl_lib.html#SslSetFd^^ ^0" +s[1188] = "ssl_openssl_lib.SslMethodV2^ssl_openssl_lib.html#SslMethodV2^^ ^0" +s[1189] = "ssl_openssl_lib.SslMethodV3^ssl_openssl_lib.html#SslMethodV3^^ ^0" +s[1190] = "ssl_openssl_lib.SslMethodTLSV1^ssl_openssl_lib.html#SslMethodTLSV1^^ ^0" +s[1191] = "ssl_openssl_lib.SslMethodV23^ssl_openssl_lib.html#SslMethodV23^^ ^0" +s[1192] = "ssl_openssl_lib.SslCtxUsePrivateKey^ssl_openssl_lib.html#SslCtxUsePrivateKey^^ ^0" +s[1193] = "ssl_openssl_lib.SslCtxUsePrivateKeyASN1^ssl_openssl_lib.html#SslCtxUsePrivateKeyASN1^^ ^0" +s[1194] = "ssl_openssl_lib.SslCtxUsePrivateKeyFile^ssl_openssl_lib.html#SslCtxUsePrivateKeyFile^^ ^0" +s[1195] = "ssl_openssl_lib.SslCtxUseCertificate^ssl_openssl_lib.html#SslCtxUseCertificate^^ ^0" +s[1196] = "ssl_openssl_lib.SslCtxUseCertificateASN1^ssl_openssl_lib.html#SslCtxUseCertificateASN1^^ ^0" +s[1197] = "ssl_openssl_lib.SslCtxUseCertificateFile^ssl_openssl_lib.html#SslCtxUseCertificateFile^^ ^0" +s[1198] = "ssl_openssl_lib.SslCtxUseCertificateChainFile^ssl_openssl_lib.html#SslCtxUseCertificateChainFile^^ ^0" +s[1199] = "ssl_openssl_lib.SslCtxCheckPrivateKeyFile^ssl_openssl_lib.html#SslCtxCheckPrivateKeyFile^^ ^0" +s[1200] = "ssl_openssl_lib.SslCtxSetDefaultPasswdCb^ssl_openssl_lib.html#SslCtxSetDefaultPasswdCb^^ ^0" +s[1201] = "ssl_openssl_lib.SslCtxSetDefaultPasswdCbUserdata^ssl_openssl_lib.html#SslCtxSetDefaultPasswdCbUserdata^^ ^0" +s[1202] = "ssl_openssl_lib.SslCtxLoadVerifyLocations^ssl_openssl_lib.html#SslCtxLoadVerifyLocations^^ ^0" +s[1203] = "ssl_openssl_lib.SslCtxCtrl^ssl_openssl_lib.html#SslCtxCtrl^^ ^0" +s[1204] = "ssl_openssl_lib.SslNew^ssl_openssl_lib.html#SslNew^^ ^0" +s[1205] = "ssl_openssl_lib.SslFree^ssl_openssl_lib.html#SslFree^^ ^0" +s[1206] = "ssl_openssl_lib.SslAccept^ssl_openssl_lib.html#SslAccept^^ ^0" +s[1207] = "ssl_openssl_lib.SslConnect^ssl_openssl_lib.html#SslConnect^^ ^0" +s[1208] = "ssl_openssl_lib.SslShutdown^ssl_openssl_lib.html#SslShutdown^^ ^0" +s[1209] = "ssl_openssl_lib.SslRead^ssl_openssl_lib.html#SslRead^^ ^0" +s[1210] = "ssl_openssl_lib.SslPeek^ssl_openssl_lib.html#SslPeek^^ ^0" +s[1211] = "ssl_openssl_lib.SslWrite^ssl_openssl_lib.html#SslWrite^^ ^0" +s[1212] = "ssl_openssl_lib.SslPending^ssl_openssl_lib.html#SslPending^^ ^0" +s[1213] = "ssl_openssl_lib.SslGetVersion^ssl_openssl_lib.html#SslGetVersion^^ ^0" +s[1214] = "ssl_openssl_lib.SslGetPeerCertificate^ssl_openssl_lib.html#SslGetPeerCertificate^^ ^0" +s[1215] = "ssl_openssl_lib.SslCtxSetVerify^ssl_openssl_lib.html#SslCtxSetVerify^^ ^0" +s[1216] = "ssl_openssl_lib.SSLGetCurrentCipher^ssl_openssl_lib.html#SSLGetCurrentCipher^^ ^0" +s[1217] = "ssl_openssl_lib.SSLCipherGetName^ssl_openssl_lib.html#SSLCipherGetName^^ ^0" +s[1218] = "ssl_openssl_lib.SSLCipherGetBits^ssl_openssl_lib.html#SSLCipherGetBits^^ ^0" +s[1219] = "ssl_openssl_lib.SSLGetVerifyResult^ssl_openssl_lib.html#SSLGetVerifyResult^^ ^0" +s[1220] = "ssl_openssl_lib.SSLCtrl^ssl_openssl_lib.html#SSLCtrl^^ ^0" +s[1221] = "ssl_openssl_lib.X509New^ssl_openssl_lib.html#X509New^^ ^0" +s[1222] = "ssl_openssl_lib.X509Free^ssl_openssl_lib.html#X509Free^^ ^0" +s[1223] = "ssl_openssl_lib.X509NameOneline^ssl_openssl_lib.html#X509NameOneline^^ ^0" +s[1224] = "ssl_openssl_lib.X509GetSubjectName^ssl_openssl_lib.html#X509GetSubjectName^^ ^0" +s[1225] = "ssl_openssl_lib.X509GetIssuerName^ssl_openssl_lib.html#X509GetIssuerName^^ ^0" +s[1226] = "ssl_openssl_lib.X509NameHash^ssl_openssl_lib.html#X509NameHash^^ ^0" +s[1227] = "ssl_openssl_lib.X509Digest^ssl_openssl_lib.html#X509Digest^^ ^0" +s[1228] = "ssl_openssl_lib.X509print^ssl_openssl_lib.html#X509print^^ ^0" +s[1229] = "ssl_openssl_lib.X509SetVersion^ssl_openssl_lib.html#X509SetVersion^^ ^0" +s[1230] = "ssl_openssl_lib.X509SetPubkey^ssl_openssl_lib.html#X509SetPubkey^^ ^0" +s[1231] = "ssl_openssl_lib.X509SetIssuerName^ssl_openssl_lib.html#X509SetIssuerName^^ ^0" +s[1232] = "ssl_openssl_lib.X509NameAddEntryByTxt^ssl_openssl_lib.html#X509NameAddEntryByTxt^^ ^0" +s[1233] = "ssl_openssl_lib.X509Sign^ssl_openssl_lib.html#X509Sign^^ ^0" +s[1234] = "ssl_openssl_lib.X509GmtimeAdj^ssl_openssl_lib.html#X509GmtimeAdj^^ ^0" +s[1235] = "ssl_openssl_lib.X509SetNotBefore^ssl_openssl_lib.html#X509SetNotBefore^^ ^0" +s[1236] = "ssl_openssl_lib.X509SetNotAfter^ssl_openssl_lib.html#X509SetNotAfter^^ ^0" +s[1237] = "ssl_openssl_lib.X509GetSerialNumber^ssl_openssl_lib.html#X509GetSerialNumber^^ ^0" +s[1238] = "ssl_openssl_lib.EvpPkeyNew^ssl_openssl_lib.html#EvpPkeyNew^^ ^0" +s[1239] = "ssl_openssl_lib.EvpPkeyFree^ssl_openssl_lib.html#EvpPkeyFree^^ ^0" +s[1240] = "ssl_openssl_lib.EvpPkeyAssign^ssl_openssl_lib.html#EvpPkeyAssign^^ ^0" +s[1241] = "ssl_openssl_lib.EvpGetDigestByName^ssl_openssl_lib.html#EvpGetDigestByName^^ ^0" +s[1242] = "ssl_openssl_lib.EVPcleanup^ssl_openssl_lib.html#EVPcleanup^^ ^0" +s[1243] = "ssl_openssl_lib.SSLeayversion^ssl_openssl_lib.html#SSLeayversion^^ ^0" +s[1244] = "ssl_openssl_lib.ErrErrorString^ssl_openssl_lib.html#ErrErrorString^^ ^0" +s[1245] = "ssl_openssl_lib.ErrGetError^ssl_openssl_lib.html#ErrGetError^^ ^0" +s[1246] = "ssl_openssl_lib.ErrClearError^ssl_openssl_lib.html#ErrClearError^^ ^0" +s[1247] = "ssl_openssl_lib.ErrFreeStrings^ssl_openssl_lib.html#ErrFreeStrings^^ ^0" +s[1248] = "ssl_openssl_lib.ErrRemoveState^ssl_openssl_lib.html#ErrRemoveState^^ ^0" +s[1249] = "ssl_openssl_lib.OPENSSLaddallalgorithms^ssl_openssl_lib.html#OPENSSLaddallalgorithms^^ ^0" +s[1250] = "ssl_openssl_lib.CRYPTOcleanupAllExData^ssl_openssl_lib.html#CRYPTOcleanupAllExData^^ ^0" +s[1251] = "ssl_openssl_lib.RandScreen^ssl_openssl_lib.html#RandScreen^^ ^0" +s[1252] = "ssl_openssl_lib.BioNew^ssl_openssl_lib.html#BioNew^^ ^0" +s[1253] = "ssl_openssl_lib.BioFreeAll^ssl_openssl_lib.html#BioFreeAll^^ ^0" +s[1254] = "ssl_openssl_lib.BioSMem^ssl_openssl_lib.html#BioSMem^^ ^0" +s[1255] = "ssl_openssl_lib.BioCtrlPending^ssl_openssl_lib.html#BioCtrlPending^^ ^0" +s[1256] = "ssl_openssl_lib.BioRead^ssl_openssl_lib.html#BioRead^^ ^0" +s[1257] = "ssl_openssl_lib.BioWrite^ssl_openssl_lib.html#BioWrite^^ ^0" +s[1258] = "ssl_openssl_lib.d2iPKCS12bio^ssl_openssl_lib.html#d2iPKCS12bio^^ ^0" +s[1259] = "ssl_openssl_lib.PKCS12parse^ssl_openssl_lib.html#PKCS12parse^^ ^0" +s[1260] = "ssl_openssl_lib.PKCS12free^ssl_openssl_lib.html#PKCS12free^^ ^0" +s[1261] = "ssl_openssl_lib.RsaGenerateKey^ssl_openssl_lib.html#RsaGenerateKey^^ ^0" +s[1262] = "ssl_openssl_lib.Asn1UtctimeNew^ssl_openssl_lib.html#Asn1UtctimeNew^^ ^0" +s[1263] = "ssl_openssl_lib.Asn1UtctimeFree^ssl_openssl_lib.html#Asn1UtctimeFree^^ ^0" +s[1264] = "ssl_openssl_lib.Asn1IntegerSet^ssl_openssl_lib.html#Asn1IntegerSet^^ ^0" +s[1265] = "ssl_openssl_lib.Asn1IntegerGet^ssl_openssl_lib.html#Asn1IntegerGet^^ ^0" +s[1266] = "ssl_openssl_lib.i2dX509bio^ssl_openssl_lib.html#i2dX509bio^^ ^0" +s[1267] = "ssl_openssl_lib.d2iX509bio^ssl_openssl_lib.html#d2iX509bio^^ ^0" +s[1268] = "ssl_openssl_lib.PEMReadBioX509^ssl_openssl_lib.html#PEMReadBioX509^^ ^0" +s[1269] = "ssl_openssl_lib.SkX509PopFree^ssl_openssl_lib.html#SkX509PopFree^^ ^0" +s[1270] = "ssl_openssl_lib.i2dPrivateKeyBio^ssl_openssl_lib.html#i2dPrivateKeyBio^^ ^0" +s[1271] = "ssl_openssl_lib.DESsetoddparity^ssl_openssl_lib.html#DESsetoddparity^^ ^0" +s[1272] = "ssl_openssl_lib.DESsetkeychecked^ssl_openssl_lib.html#DESsetkeychecked^^ ^0" +s[1273] = "ssl_openssl_lib.DESecbencrypt^ssl_openssl_lib.html#DESecbencrypt^^ ^0" +s[1274] = "ssl_openssl_lib.IsSSLloaded^ssl_openssl_lib.html#IsSSLloaded^^ ^0" +s[1275] = "ssl_openssl_lib.InitSSLInterface^ssl_openssl_lib.html#InitSSLInterface^^ ^0" +s[1276] = "ssl_openssl_lib.DestroySSLInterface^ssl_openssl_lib.html#DestroySSLInterface^^ ^0" +s[1277] = "ssl_openssl_lib.SslPtr^ssl_openssl_lib.html#SslPtr^^ ^0" +s[1278] = "ssl_openssl_lib.PSslPtr^ssl_openssl_lib.html#PSslPtr^^ ^0" +s[1279] = "ssl_openssl_lib.PSSL_CTX^ssl_openssl_lib.html#PSSL_CTX^^ ^0" +s[1280] = "ssl_openssl_lib.PSSL^ssl_openssl_lib.html#PSSL^^ ^0" +s[1281] = "ssl_openssl_lib.PSSL_METHOD^ssl_openssl_lib.html#PSSL_METHOD^^ ^0" +s[1282] = "ssl_openssl_lib.PX509^ssl_openssl_lib.html#PX509^^ ^0" +s[1283] = "ssl_openssl_lib.PX509_NAME^ssl_openssl_lib.html#PX509_NAME^^ ^0" +s[1284] = "ssl_openssl_lib.PEVP_MD^ssl_openssl_lib.html#PEVP_MD^^ ^0" +s[1285] = "ssl_openssl_lib.PInteger^ssl_openssl_lib.html#PInteger^^ ^0" +s[1286] = "ssl_openssl_lib.PBIO_METHOD^ssl_openssl_lib.html#PBIO_METHOD^^ ^0" +s[1287] = "ssl_openssl_lib.PBIO^ssl_openssl_lib.html#PBIO^^ ^0" +s[1288] = "ssl_openssl_lib.EVP_PKEY^ssl_openssl_lib.html#EVP_PKEY^^ ^0" +s[1289] = "ssl_openssl_lib.PRSA^ssl_openssl_lib.html#PRSA^^ ^0" +s[1290] = "ssl_openssl_lib.PASN1_UTCTIME^ssl_openssl_lib.html#PASN1_UTCTIME^^ ^0" +s[1291] = "ssl_openssl_lib.PASN1_INTEGER^ssl_openssl_lib.html#PASN1_INTEGER^^ ^0" +s[1292] = "ssl_openssl_lib.PPasswdCb^ssl_openssl_lib.html#PPasswdCb^^ ^0" +s[1293] = "ssl_openssl_lib.PFunction^ssl_openssl_lib.html#PFunction^^ ^0" +s[1294] = "ssl_openssl_lib.PSTACK^ssl_openssl_lib.html#PSTACK^^ ^0" +s[1295] = "ssl_openssl_lib.TSkPopFreeFunc^ssl_openssl_lib.html#TSkPopFreeFunc^^ ^0" +s[1296] = "ssl_openssl_lib.TX509Free^ssl_openssl_lib.html#TX509Free^^ ^0" +s[1297] = "ssl_openssl_lib.DES_cblock^ssl_openssl_lib.html#DES_cblock^^ ^0" +s[1298] = "ssl_openssl_lib.PDES_cblock^ssl_openssl_lib.html#PDES_cblock^^ ^0" +s[1299] = "ssl_openssl_lib.des_key_schedule^ssl_openssl_lib.html#des_key_schedule^^ ^0" +s[1300] = "ssl_openssl_lib.DLLSSLName^ssl_openssl_lib.html#DLLSSLName^^ ^0" +s[1301] = "ssl_openssl_lib.DLLSSLName2^ssl_openssl_lib.html#DLLSSLName2^^ ^0" +s[1302] = "ssl_openssl_lib.DLLUtilName^ssl_openssl_lib.html#DLLUtilName^^ ^0" +s[1303] = "ssl_openssl_lib.SSLLibHandle^ssl_openssl_lib.html#SSLLibHandle^^ ^0" +s[1304] = "ssl_openssl_lib.SSLUtilHandle^ssl_openssl_lib.html#SSLUtilHandle^^ ^0" +s[1305] = "ssl_openssl_lib.SSLLibFile^ssl_openssl_lib.html#SSLLibFile^^ ^0" +s[1306] = "ssl_openssl_lib.SSLUtilFile^ssl_openssl_lib.html#SSLUtilFile^^ ^0" +s[1307] = "ssl_openssl_lib._X509Free^ssl_openssl_lib.html#_X509Free^^ ^0" +s[1308] = "ssl_sbb^ssl_sbb.html^SSL plugin for Eldos SecureBlackBox^

For handling keys and certificates you can use this properties: TCustomSSL.CertCAFile, TCustomSSL.CertCA, TCustomSSL.TrustCertificateFile, TCustomSSL.TrustCertificate, TCustomSSL.PrivateKeyFile, TCustomSSL.PrivateKey, TCustomSSL.CertificateFile, TCustomSSL.Certificate, TCustomSSL.PFXfile. For usage of this properties and for possible formats of keys and certificates refer to SecureBlackBox documentation. ^0" +s[1309] = "ssl_sbb.TSSLSBB^ssl_sbb.TSSLSBB.html^class implementing SecureBlackbox SSL plugin.^ Instance of this class will be created for each TTCPBlockSocket. You not need to create instance of this class, all is done by Synapse itself! ^0" +s[1310] = "ssl_sbb.TSSLSBB.Create^ssl_sbb.TSSLSBB.html#Create^^ ^0" +s[1311] = "ssl_sbb.TSSLSBB.Destroy^ssl_sbb.TSSLSBB.html#Destroy^^ ^0" +s[1312] = "ssl_sbb.TSSLSBB.LibVersion^ssl_sbb.TSSLSBB.html#LibVersion^^See TCustomSSL.LibVersion ^0" +s[1313] = "ssl_sbb.TSSLSBB.LibName^ssl_sbb.TSSLSBB.html#LibName^^See TCustomSSL.LibName ^0" +s[1314] = "ssl_sbb.TSSLSBB.Connect^ssl_sbb.TSSLSBB.html#Connect^^See TCustomSSL.Connect and ssl_sbb for more details. ^0" +s[1315] = "ssl_sbb.TSSLSBB.Accept^ssl_sbb.TSSLSBB.html#Accept^^See TCustomSSL.Accept and ssl_sbb for more details. ^0" +s[1316] = "ssl_sbb.TSSLSBB.Shutdown^ssl_sbb.TSSLSBB.html#Shutdown^^See TCustomSSL.Shutdown ^0" +s[1317] = "ssl_sbb.TSSLSBB.BiShutdown^ssl_sbb.TSSLSBB.html#BiShutdown^^See TCustomSSL.BiShutdown ^0" +s[1318] = "ssl_sbb.TSSLSBB.SendBuffer^ssl_sbb.TSSLSBB.html#SendBuffer^^See TCustomSSL.SendBuffer ^0" +s[1319] = "ssl_sbb.TSSLSBB.RecvBuffer^ssl_sbb.TSSLSBB.html#RecvBuffer^^See TCustomSSL.RecvBuffer ^0" +s[1320] = "ssl_sbb.TSSLSBB.WaitingData^ssl_sbb.TSSLSBB.html#WaitingData^^See TCustomSSL.WaitingData ^0" +s[1321] = "ssl_sbb.TSSLSBB.GetSSLVersion^ssl_sbb.TSSLSBB.html#GetSSLVersion^^See TCustomSSL.GetSSLVersion ^0" +s[1322] = "ssl_sbb.TSSLSBB.GetPeerSubject^ssl_sbb.TSSLSBB.html#GetPeerSubject^^See TCustomSSL.GetPeerSubject ^0" +s[1323] = "ssl_sbb.TSSLSBB.GetPeerIssuer^ssl_sbb.TSSLSBB.html#GetPeerIssuer^^See TCustomSSL.GetPeerIssuer ^0" +s[1324] = "ssl_sbb.TSSLSBB.GetPeerName^ssl_sbb.TSSLSBB.html#GetPeerName^^See TCustomSSL.GetPeerName ^0" +s[1325] = "ssl_sbb.TSSLSBB.GetPeerFingerprint^ssl_sbb.TSSLSBB.html#GetPeerFingerprint^^See TCustomSSL.GetPeerFingerprint ^0" +s[1326] = "ssl_sbb.TSSLSBB.GetCertInfo^ssl_sbb.TSSLSBB.html#GetCertInfo^^See TCustomSSL.GetCertInfo ^0" +s[1327] = "ssl_sbb.TSSLSBB.ElSecureClient^ssl_sbb.TSSLSBB.html#ElSecureClient^^ ^0" +s[1328] = "ssl_sbb.TSSLSBB.ElSecureServer^ssl_sbb.TSSLSBB.html#ElSecureServer^^ ^0" +s[1329] = "ssl_sbb.TSSLSBB.CipherSuites^ssl_sbb.TSSLSBB.html#CipherSuites^^ ^0" +s[1330] = "ssl_sbb.TSSLSBB.CipherSuite^ssl_sbb.TSSLSBB.html#CipherSuite^^ ^0" +s[1331] = "ssl_sbb.DEFAULT_RECV_BUFFER^ssl_sbb.html#DEFAULT_RECV_BUFFER^^ ^0" +s[1332] = "ssl_streamsec^ssl_streamsec.html^SSL plugin for StreamSecII or OpenStreamSecII^

StreamSecII is native pascal library, you not need any external libraries!

If you are not using key and certificate by GlobalServer, then you can use properties of this plugin instead, but this have limited features and TCustomSSL.KeyPassword not working properly yet!

For handling keys and certificates you can use this properties: TCustomSSL.CertCAFile, TCustomSSL.CertCA, TCustomSSL.TrustCertificateFile, TCustomSSL.TrustCertificate, TCustomSSL.PrivateKeyFile, TCustomSSL.PrivateKey, TCustomSSL.CertificateFile, TCustomSSL.Certificate, TCustomSSL.PFXfile. For usage of this properties and for possible formats of keys and certificates refer to StreamSecII documentation. ^0" +s[1333] = "ssl_streamsec.TSSLStreamSec^ssl_streamsec.TSSLStreamSec.html^class implementing StreamSecII SSL plugin.^ Instance of this class will be created for each TTCPBlockSocket. You not need to create instance of this class, all is done by Synapse itself! ^0" +s[1334] = "ssl_streamsec.TSSLStreamSec.Create^ssl_streamsec.TSSLStreamSec.html#Create^^ ^0" +s[1335] = "ssl_streamsec.TSSLStreamSec.Destroy^ssl_streamsec.TSSLStreamSec.html#Destroy^^ ^0" +s[1336] = "ssl_streamsec.TSSLStreamSec.LibVersion^ssl_streamsec.TSSLStreamSec.html#LibVersion^^See TCustomSSL.LibVersion ^0" +s[1337] = "ssl_streamsec.TSSLStreamSec.LibName^ssl_streamsec.TSSLStreamSec.html#LibName^^See TCustomSSL.LibName ^0" +s[1338] = "ssl_streamsec.TSSLStreamSec.Connect^ssl_streamsec.TSSLStreamSec.html#Connect^^See TCustomSSL.Connect and ssl_streamsec for more details. ^0" +s[1339] = "ssl_streamsec.TSSLStreamSec.Accept^ssl_streamsec.TSSLStreamSec.html#Accept^^See TCustomSSL.Accept and ssl_streamsec for more details. ^0" +s[1340] = "ssl_streamsec.TSSLStreamSec.Shutdown^ssl_streamsec.TSSLStreamSec.html#Shutdown^^See TCustomSSL.Shutdown ^0" +s[1341] = "ssl_streamsec.TSSLStreamSec.BiShutdown^ssl_streamsec.TSSLStreamSec.html#BiShutdown^^See TCustomSSL.BiShutdown ^0" +s[1342] = "ssl_streamsec.TSSLStreamSec.SendBuffer^ssl_streamsec.TSSLStreamSec.html#SendBuffer^^See TCustomSSL.SendBuffer ^0" +s[1343] = "ssl_streamsec.TSSLStreamSec.RecvBuffer^ssl_streamsec.TSSLStreamSec.html#RecvBuffer^^See TCustomSSL.RecvBuffer ^0" +s[1344] = "ssl_streamsec.TSSLStreamSec.WaitingData^ssl_streamsec.TSSLStreamSec.html#WaitingData^^See TCustomSSL.WaitingData ^0" +s[1345] = "ssl_streamsec.TSSLStreamSec.GetSSLVersion^ssl_streamsec.TSSLStreamSec.html#GetSSLVersion^^See TCustomSSL.GetSSLVersion ^0" +s[1346] = "ssl_streamsec.TSSLStreamSec.GetPeerSubject^ssl_streamsec.TSSLStreamSec.html#GetPeerSubject^^See TCustomSSL.GetPeerSubject ^0" +s[1347] = "ssl_streamsec.TSSLStreamSec.GetPeerIssuer^ssl_streamsec.TSSLStreamSec.html#GetPeerIssuer^^See TCustomSSL.GetPeerIssuer ^0" +s[1348] = "ssl_streamsec.TSSLStreamSec.GetPeerName^ssl_streamsec.TSSLStreamSec.html#GetPeerName^^See TCustomSSL.GetPeerName ^0" +s[1349] = "ssl_streamsec.TSSLStreamSec.GetPeerFingerprint^ssl_streamsec.TSSLStreamSec.html#GetPeerFingerprint^^See TCustomSSL.GetPeerFingerprint ^0" +s[1350] = "ssl_streamsec.TSSLStreamSec.GetCertInfo^ssl_streamsec.TSSLStreamSec.html#GetCertInfo^^See TCustomSSL.GetCertInfo ^0" +s[1351] = "ssl_streamsec.TSSLStreamSec.TLSServer^ssl_streamsec.TSSLStreamSec.html#TLSServer^^TLS server for tuning of StreamSecII. ^0" +s[1352] = "synachar^synachar.html^Charset conversion support^ This unit contains a routines for lot of charset conversions.

Internal routines knows all major charsets for Europe or America. For East-Asian charsets you must use Iconv library! ^0" +s[1353] = "synachar.IconvOnlyChars^synachar.html#IconvOnlyChars^^Set of charsets supported by Iconv library only. ^0" +s[1354] = "synachar.NoIconvChars^synachar.html#NoIconvChars^^Set of charsets supported by internal routines only. ^0" +s[1355] = "synachar.Replace_None^synachar.html#Replace_None^^null character replace table. (Usable for disable charater replacing.) ^0" +s[1356] = "synachar.Replace_Czech^synachar.html#Replace_Czech^^Character replace table for remove Czech diakritics. ^0" +s[1357] = "synachar.CharsetConversion^synachar.html#CharsetConversion^^Convert Value from one charset to another. See: CharsetConversionEx ^0" +s[1358] = "synachar.CharsetConversionEx^synachar.html#CharsetConversionEx^^Convert Value from one charset to another with additional character conversion. see: Replace_None and Replace_Czech ^0" +s[1359] = "synachar.CharsetConversionTrans^synachar.html#CharsetConversionTrans^^Convert Value from one charset to another with additional character conversion. This funtion is similar to CharsetConversionEx, but you can disable transliteration of unconvertible characters. ^0" +s[1360] = "synachar.GetCurCP^synachar.html#GetCurCP^^Returns charset used by operating system. ^0" +s[1361] = "synachar.GetCurOEMCP^synachar.html#GetCurOEMCP^^Returns charset used by operating system as OEM charset. (in Windows DOS box, for example) ^0" +s[1362] = "synachar.GetCPFromID^synachar.html#GetCPFromID^^Converting string with charset name to TMimeChar. ^0" +s[1363] = "synachar.GetIDFromCP^synachar.html#GetIDFromCP^^Converting TMimeChar to string with name of charset. ^0" +s[1364] = "synachar.NeedCharsetConversion^synachar.html#NeedCharsetConversion^^return True when value need to be converted. (It is not 7-bit ASCII) ^0" +s[1365] = "synachar.IdealCharsetCoding^synachar.html#IdealCharsetCoding^^Finding best target charset from set of TMimeChars with minimal count of unconvertible characters. ^0" +s[1366] = "synachar.GetBOM^synachar.html#GetBOM^^Return BOM (Byte Order Mark) for given unicode charset. ^0" +s[1367] = "synachar.StringToWide^synachar.html#StringToWide^^Convert binary string with unicode content to WideString. ^0" +s[1368] = "synachar.WideToString^synachar.html#WideToString^^Convert WideString to binary string with unicode content. ^0" +s[1369] = "synachar.TMimeChar^synachar.html#TMimeChar^^Type with all supported charsets. ISO_8859_1 ISO_8859_2 ISO_8859_3 ISO_8859_4 ISO_8859_5 ISO_8859_6 ISO_8859_7 ISO_8859_8 ISO_8859_9 ISO_8859_10 ISO_8859_13 ISO_8859_14 ISO_8859_15 CP1250 CP1251 CP1252 CP1253 CP1254 CP1255 CP1256 CP1257 CP1258 KOI8_R CP895 CP852 UCS_2 UCS_4 UTF_8 UTF_7 UTF_7mod UCS_2LE UCS_4LE UTF_16 UTF_16LE UTF_32 UTF_32LE C99 JAVA ISO_8859_16 KOI8_U KOI8_RU CP862 CP866 MAC MACCE MACICE MACCRO MACRO MACCYR MACUK MACGR MACTU MACHEB MACAR MACTH ROMAN8 NEXTSTEP ARMASCII GEORGIAN_AC GEORGIAN_PS KOI8_T MULELAO CP1133 TIS620 CP874 VISCII TCVN ISO_IR_14 JIS_X0201 JIS_X0208 JIS_X0212 GB1988_80 GB2312_80 ISO_IR_165 ISO_IR_149 EUC_JP SHIFT_JIS CP932 ISO_2022_JP ISO_2022_JP1 ISO_2022_JP2 GB2312 CP936 GB18030 ISO_2022_CN ISO_2022_CNE HZ EUC_TW BIG5 CP950 BIG5_HKSCS EUC_KR CP949 CP1361 ISO_2022_KR CP737 CP775 CP853 CP855 CP857 CP858 CP860 CP861 CP863 CP864 CP865 CP869 CP1125 ^0" +s[1370] = "synachar.TMimeSetChar^synachar.html#TMimeSetChar^^Set of any charsets. ^0" +s[1371] = "synachar.DisableIconv^synachar.html#DisableIconv^^By this you can generally disable/enable Iconv support. ^0" +s[1372] = "synachar.IdealCharsets^synachar.html#IdealCharsets^^Default set of charsets for IdealCharsetCoding function. ^0" +s[1373] = "synacode^synacode.html^Various encoding and decoding support^ ^0" +s[1374] = "synacode.SpecialChar^synacode.html#SpecialChar^^ ^0" +s[1375] = "synacode.NonAsciiChar^synacode.html#NonAsciiChar^^ ^0" +s[1376] = "synacode.URLFullSpecialChar^synacode.html#URLFullSpecialChar^^ ^0" +s[1377] = "synacode.URLSpecialChar^synacode.html#URLSpecialChar^^ ^0" +s[1378] = "synacode.TableBase64^synacode.html#TableBase64^^ ^0" +s[1379] = "synacode.TableBase64mod^synacode.html#TableBase64mod^^ ^0" +s[1380] = "synacode.TableUU^synacode.html#TableUU^^ ^0" +s[1381] = "synacode.TableXX^synacode.html#TableXX^^ ^0" +s[1382] = "synacode.ReTablebase64^synacode.html#ReTablebase64^^ ^0" +s[1383] = "synacode.ReTableUU^synacode.html#ReTableUU^^ ^0" +s[1384] = "synacode.ReTableXX^synacode.html#ReTableXX^^ ^0" +s[1385] = "synacode.DecodeTriplet^synacode.html#DecodeTriplet^^Decodes triplet encoding with a given character delimiter. It is used for decoding quoted-printable or URL encoding. ^0" +s[1386] = "synacode.DecodeQuotedPrintable^synacode.html#DecodeQuotedPrintable^^Decodes a string from quoted printable form. (also decodes triplet sequences like '=7F') ^0" +s[1387] = "synacode.DecodeURL^synacode.html#DecodeURL^^Decodes a string of URL encoding. (also decodes triplet sequences like '%7F') ^0" +s[1388] = "synacode.EncodeTriplet^synacode.html#EncodeTriplet^^Performs triplet encoding with a given character delimiter. Used for encoding quoted-printable or URL encoding. ^0" +s[1389] = "synacode.EncodeQuotedPrintable^synacode.html#EncodeQuotedPrintable^^Encodes a string to triplet quoted printable form. All NonAsciiChar are encoded. ^0" +s[1390] = "synacode.EncodeSafeQuotedPrintable^synacode.html#EncodeSafeQuotedPrintable^^Encodes a string to triplet quoted printable form. All NonAsciiChar and SpecialChar are encoded. ^0" +s[1391] = "synacode.EncodeURLElement^synacode.html#EncodeURLElement^^Encodes a string to URL format. Used for encoding data from a form field in HTTP, etc. (Encodes all critical characters including characters used as URL delimiters ('/',':', etc.) ^0" +s[1392] = "synacode.EncodeURL^synacode.html#EncodeURL^^Encodes a string to URL format. Used to encode critical characters in all URLs. ^0" +s[1393] = "synacode.Decode4to3^synacode.html#Decode4to3^^Decode 4to3 encoding with given table. If some element is not found in table, first item from table is used. This is good for buggy coded items by Microsoft Outlook. This software sometimes using wrong table for UUcode, where is used ' ' instead '`'. ^0" +s[1394] = "synacode.Decode4to3Ex^synacode.html#Decode4to3Ex^^Decode 4to3 encoding with given REVERSE table. Using this function with reverse table is much faster then Decode4to3. This function is used internally for Base64, UU or XX decoding. ^0" +s[1395] = "synacode.Encode3to4^synacode.html#Encode3to4^^Encode by system 3to4 (used by Base64, UU coding, etc) by given table. ^0" +s[1396] = "synacode.DecodeBase64^synacode.html#DecodeBase64^^Decode string from base64 format. ^0" +s[1397] = "synacode.EncodeBase64^synacode.html#EncodeBase64^^Encodes a string to base64 format. ^0" +s[1398] = "synacode.DecodeBase64mod^synacode.html#DecodeBase64mod^^Decode string from modified base64 format. (used in IMAP, for example.) ^0" +s[1399] = "synacode.EncodeBase64mod^synacode.html#EncodeBase64mod^^Encodes a string to modified base64 format. (used in IMAP, for example.) ^0" +s[1400] = "synacode.DecodeUU^synacode.html#DecodeUU^^Decodes a string from UUcode format. ^0" +s[1401] = "synacode.EncodeUU^synacode.html#EncodeUU^^encode UUcode. it encode only datas, you must also add header and footer for proper encode. ^0" +s[1402] = "synacode.DecodeXX^synacode.html#DecodeXX^^Decodes a string from XXcode format. ^0" +s[1403] = "synacode.DecodeYEnc^synacode.html#DecodeYEnc^^decode line with Yenc code. This code is sometimes used in newsgroups. ^0" +s[1404] = "synacode.UpdateCrc32^synacode.html#UpdateCrc32^^Returns a new CRC32 value after adding a new byte of data. ^0" +s[1405] = "synacode.Crc32^synacode.html#Crc32^^return CRC32 from a value string. ^0" +s[1406] = "synacode.UpdateCrc16^synacode.html#UpdateCrc16^^Returns a new CRC16 value after adding a new byte of data. ^0" +s[1407] = "synacode.Crc16^synacode.html#Crc16^^return CRC16 from a value string. ^0" +s[1408] = "synacode.MD5^synacode.html#MD5^^Returns a binary string with a RSA-MD5 hashing of "Value" string. ^0" +s[1409] = "synacode.HMAC_MD5^synacode.html#HMAC_MD5^^Returns a binary string with HMAC-MD5 hash. ^0" +s[1410] = "synacode.MD5LongHash^synacode.html#MD5LongHash^^Returns a binary string with a RSA-MD5 hashing of string what is constructed by repeating "value" until length is "Len". ^0" +s[1411] = "synacode.SHA1^synacode.html#SHA1^^Returns a binary string with a SHA-1 hashing of "Value" string. ^0" +s[1412] = "synacode.HMAC_SHA1^synacode.html#HMAC_SHA1^^Returns a binary string with HMAC-SHA1 hash. ^0" +s[1413] = "synacode.SHA1LongHash^synacode.html#SHA1LongHash^^Returns a binary string with a SHA-1 hashing of string what is constructed by repeating "value" until length is "Len". ^0" +s[1414] = "synacode.MD4^synacode.html#MD4^^Returns a binary string with a RSA-MD4 hashing of "Value" string. ^0" +s[1415] = "synacode.TSpecials^synacode.html#TSpecials^^ ^0" +s[1416] = "synacrypt^synacrypt.html^Encryption support^

Implemented are DES and 3DES encryption/decryption by ECB, CBC, CFB-8bit, CFB-block, OFB and CTR methods. ^0" +s[1417] = "synacrypt.TSynaBlockCipher^synacrypt.TSynaBlockCipher.html^Implementation of common routines block ciphers (dafault size is 64-bits)^

Do not use this class directly, use descendants only! ^0" +s[1418] = "synacrypt.TSynaBlockCipher.SetIV^synacrypt.TSynaBlockCipher.html#SetIV^^Sets the IV to Value and performs a reset ^0" +s[1419] = "synacrypt.TSynaBlockCipher.GetIV^synacrypt.TSynaBlockCipher.html#GetIV^^Returns the current chaining information, not the actual IV ^0" +s[1420] = "synacrypt.TSynaBlockCipher.Reset^synacrypt.TSynaBlockCipher.html#Reset^^Reset any stored chaining information ^0" +s[1421] = "synacrypt.TSynaBlockCipher.EncryptECB^synacrypt.TSynaBlockCipher.html#EncryptECB^^Encrypt a 64-bit block of data using the ECB method of encryption ^0" +s[1422] = "synacrypt.TSynaBlockCipher.DecryptECB^synacrypt.TSynaBlockCipher.html#DecryptECB^^Decrypt a 64-bit block of data using the ECB method of decryption ^0" +s[1423] = "synacrypt.TSynaBlockCipher.EncryptCBC^synacrypt.TSynaBlockCipher.html#EncryptCBC^^Encrypt data using the CBC method of encryption ^0" +s[1424] = "synacrypt.TSynaBlockCipher.DecryptCBC^synacrypt.TSynaBlockCipher.html#DecryptCBC^^Decrypt data using the CBC method of decryption ^0" +s[1425] = "synacrypt.TSynaBlockCipher.EncryptCFB8bit^synacrypt.TSynaBlockCipher.html#EncryptCFB8bit^^Encrypt data using the CFB (8 bit) method of encryption ^0" +s[1426] = "synacrypt.TSynaBlockCipher.DecryptCFB8bit^synacrypt.TSynaBlockCipher.html#DecryptCFB8bit^^Decrypt data using the CFB (8 bit) method of decryption ^0" +s[1427] = "synacrypt.TSynaBlockCipher.EncryptCFBblock^synacrypt.TSynaBlockCipher.html#EncryptCFBblock^^Encrypt data using the CFB (block) method of encryption ^0" +s[1428] = "synacrypt.TSynaBlockCipher.DecryptCFBblock^synacrypt.TSynaBlockCipher.html#DecryptCFBblock^^Decrypt data using the CFB (block) method of decryption ^0" +s[1429] = "synacrypt.TSynaBlockCipher.EncryptOFB^synacrypt.TSynaBlockCipher.html#EncryptOFB^^Encrypt data using the OFB method of encryption ^0" +s[1430] = "synacrypt.TSynaBlockCipher.DecryptOFB^synacrypt.TSynaBlockCipher.html#DecryptOFB^^Decrypt data using the OFB method of decryption ^0" +s[1431] = "synacrypt.TSynaBlockCipher.EncryptCTR^synacrypt.TSynaBlockCipher.html#EncryptCTR^^Encrypt data using the CTR method of encryption ^0" +s[1432] = "synacrypt.TSynaBlockCipher.DecryptCTR^synacrypt.TSynaBlockCipher.html#DecryptCTR^^Decrypt data using the CTR method of decryption ^0" +s[1433] = "synacrypt.TSynaBlockCipher.Create^synacrypt.TSynaBlockCipher.html#Create^^Create a encryptor/decryptor instance and initialize it by the Key. ^0" +s[1434] = "synacrypt.TSynaCustomDes^synacrypt.TSynaCustomDes.html^Implementation of common routines for DES encryption^

Do not use this class directly, use descendants only! ^0" +s[1435] = "synacrypt.TSynaDes^synacrypt.TSynaDes.html^Implementation of DES encryption^ ^0" +s[1436] = "synacrypt.TSynaDes.EncryptECB^synacrypt.TSynaDes.html#EncryptECB^^Encrypt a 64-bit block of data using the ECB method of encryption ^0" +s[1437] = "synacrypt.TSynaDes.DecryptECB^synacrypt.TSynaDes.html#DecryptECB^^Decrypt a 64-bit block of data using the ECB method of decryption ^0" +s[1438] = "synacrypt.TSyna3Des^synacrypt.TSyna3Des.html^Implementation of 3DES encryption^ ^0" +s[1439] = "synacrypt.TSyna3Des.EncryptECB^synacrypt.TSyna3Des.html#EncryptECB^^Encrypt a 64-bit block of data using the ECB method of encryption ^0" +s[1440] = "synacrypt.TSyna3Des.DecryptECB^synacrypt.TSyna3Des.html#DecryptECB^^Decrypt a 64-bit block of data using the ECB method of decryption ^0" +s[1441] = "synacrypt.TSynaAes^synacrypt.TSynaAes.html^Implementation of AES encryption^ ^0" +s[1442] = "synacrypt.TSynaAes.EncryptECB^synacrypt.TSynaAes.html#EncryptECB^^Encrypt a 128-bit block of data using the ECB method of encryption ^0" +s[1443] = "synacrypt.TSynaAes.DecryptECB^synacrypt.TSynaAes.html#DecryptECB^^Decrypt a 128-bit block of data using the ECB method of decryption ^0" +s[1444] = "synacrypt.BC^synacrypt.html#BC^^ ^0" +s[1445] = "synacrypt.MAXROUNDS^synacrypt.html#MAXROUNDS^^ ^0" +s[1446] = "synacrypt.TestDes^synacrypt.html#TestDes^^Call internal test of all DES encryptions. Returns True if all is OK. ^0" +s[1447] = "synacrypt.Test3Des^synacrypt.html#Test3Des^^Call internal test of all 3DES encryptions. Returns True if all is OK. ^0" +s[1448] = "synacrypt.TestAes^synacrypt.html#TestAes^^Call internal test of all AES encryptions. Returns True if all is OK. ^0" +s[1449] = "synacrypt.TDesKeyData^synacrypt.html#TDesKeyData^Datatype for holding one DES key data^

This data type is used internally. ^0" +s[1450] = "synadbg^synadbg.html^Socket debug tools^

Routines for help with debugging of events on the Sockets. ^0" +s[1451] = "synadbg.TSynaDebug^synadbg.TSynaDebug.html^^ ^0" +s[1452] = "synadbg.TSynaDebug.HookStatus^synadbg.TSynaDebug.html#HookStatus^^ ^0" +s[1453] = "synadbg.TSynaDebug.HookMonitor^synadbg.TSynaDebug.html#HookMonitor^^ ^0" +s[1454] = "synadbg.AppendToLog^synadbg.html#AppendToLog^^ ^0" +s[1455] = "synadbg.LogFile^synadbg.html#LogFile^^ ^0" +s[1456] = "synafpc^synafpc.html^^ ^0" +s[1457] = "synafpc.Sleep^synafpc.html#Sleep^^ ^0" +s[1458] = "synafpc.TLibHandle^synafpc.html#TLibHandle^^ ^0" +s[1459] = "synafpc.PtrInt^synafpc.html#PtrInt^^ ^0" +s[1460] = "synaicnv^synaicnv.html^LibIconv support^

This unit is Pascal interface to LibIconv library for charset translations. LibIconv is loaded dynamicly on-demand. If this library is not found in system, requested LibIconv function just return errorcode. ^0" +s[1461] = "synaicnv.DLLIconvName^synaicnv.html#DLLIconvName^^ ^0" +s[1462] = "synaicnv.ICONV_TRIVIALP^synaicnv.html#ICONV_TRIVIALP^^ ^0" +s[1463] = "synaicnv.ICONV_GET_TRANSLITERATE^synaicnv.html#ICONV_GET_TRANSLITERATE^^ ^0" +s[1464] = "synaicnv.ICONV_SET_TRANSLITERATE^synaicnv.html#ICONV_SET_TRANSLITERATE^^ ^0" +s[1465] = "synaicnv.ICONV_GET_DISCARD_ILSEQ^synaicnv.html#ICONV_GET_DISCARD_ILSEQ^^ ^0" +s[1466] = "synaicnv.ICONV_SET_DISCARD_ILSEQ^synaicnv.html#ICONV_SET_DISCARD_ILSEQ^^ ^0" +s[1467] = "synaicnv.SynaIconvOpen^synaicnv.html#SynaIconvOpen^^ ^0" +s[1468] = "synaicnv.SynaIconvOpenTranslit^synaicnv.html#SynaIconvOpenTranslit^^ ^0" +s[1469] = "synaicnv.SynaIconvOpenIgnore^synaicnv.html#SynaIconvOpenIgnore^^ ^0" +s[1470] = "synaicnv.SynaIconv^synaicnv.html#SynaIconv^^ ^0" +s[1471] = "synaicnv.SynaIconvClose^synaicnv.html#SynaIconvClose^^ ^0" +s[1472] = "synaicnv.SynaIconvCtl^synaicnv.html#SynaIconvCtl^^ ^0" +s[1473] = "synaicnv.IsIconvloaded^synaicnv.html#IsIconvloaded^^ ^0" +s[1474] = "synaicnv.InitIconvInterface^synaicnv.html#InitIconvInterface^^ ^0" +s[1475] = "synaicnv.DestroyIconvInterface^synaicnv.html#DestroyIconvInterface^^ ^0" +s[1476] = "synaicnv.size_t^synaicnv.html#size_t^^ ^0" +s[1477] = "synaicnv.iconv_t^synaicnv.html#iconv_t^^ ^0" +s[1478] = "synaicnv.argptr^synaicnv.html#argptr^^ ^0" +s[1479] = "synaicnv.iconvLibHandle^synaicnv.html#iconvLibHandle^^ ^0" +s[1480] = "synaip^synaip.html^IP adress support procedures and functions^ ^0" +s[1481] = "synaip.IsIP^synaip.html#IsIP^^Returns True, if "Value" is a valid IPv4 address. Cannot be a symbolic Name! ^0" +s[1482] = "synaip.IsIP6^synaip.html#IsIP6^^Returns True, if "Value" is a valid IPv6 address. Cannot be a symbolic Name! ^0" +s[1483] = "synaip.IPToID^synaip.html#IPToID^^Returns a string with the "Host" ip address converted to binary form. ^0" +s[1484] = "synaip.StrToIp6^synaip.html#StrToIp6^^Convert IPv6 address from their string form to binary byte array. ^0" +s[1485] = "synaip.Ip6ToStr^synaip.html#Ip6ToStr^^Convert IPv6 address from binary byte array to string form. ^0" +s[1486] = "synaip.StrToIp^synaip.html#StrToIp^^Convert IPv4 address from their string form to binary. ^0" +s[1487] = "synaip.IpToStr^synaip.html#IpToStr^^Convert IPv4 address from binary to string form. ^0" +s[1488] = "synaip.ReverseIP^synaip.html#ReverseIP^^Convert IPv4 address to reverse form. ^0" +s[1489] = "synaip.ReverseIP6^synaip.html#ReverseIP6^^Convert IPv6 address to reverse form. ^0" +s[1490] = "synaip.ExpandIP6^synaip.html#ExpandIP6^^Expand short form of IPv6 address to long form. ^0" +s[1491] = "synaip.TIp6Bytes^synaip.html#TIp6Bytes^^binary form of IPv6 adress (for string conversion routines) ^0" +s[1492] = "synaip.TIp6Words^synaip.html#TIp6Words^^binary form of IPv6 adress (for string conversion routines) ^0" +s[1493] = "synamisc^synamisc.html^^ ^0" +s[1494] = "synamisc.TProxySetting^synamisc.TProxySetting.html^This record contains information about proxy setting.^ ^0" +s[1495] = "synamisc.TProxySetting.Host^synamisc.TProxySetting.html#Host^^ ^0" +s[1496] = "synamisc.TProxySetting.Port^synamisc.TProxySetting.html#Port^^ ^0" +s[1497] = "synamisc.TProxySetting.Bypass^synamisc.TProxySetting.html#Bypass^^ ^0" +s[1498] = "synamisc.WakeOnLan^synamisc.html#WakeOnLan^^By this function you can turn-on computer on network, if this computer supporting Wake-on-lan feature. You need MAC number (network card indentifier) of computer for turn-on. You can also assign target IP addres. If you not specify it, then is used broadcast for delivery magic wake-on packet. However broadcasts workinh only on your local network. When you need to wake-up computer on another network, you must specify any existing IP addres on same network segment as targeting computer. ^0" +s[1499] = "synamisc.GetDNS^synamisc.html#GetDNS^^Autodetect current DNS servers used by system. If is defined more then one DNS server, then result is comma-delimited. ^0" +s[1500] = "synamisc.GetIEProxy^synamisc.html#GetIEProxy^^Autodetect InternetExplorer proxy setting for given protocol. This function working only on windows! ^0" +s[1501] = "synamisc.GetLocalIPs^synamisc.html#GetLocalIPs^^Return all known IP addresses on local system. Addresses are divided by comma. ^0" +s[1502] = "synaser^synaser.html^^ ^0" +s[1503] = "synaser.ESynaSerError^synaser.ESynaSerError.html^Exception type for SynaSer errors^ ^0" +s[1504] = "synaser.ESynaSerError.ErrorCode^synaser.ESynaSerError.html#ErrorCode^^ ^0" +s[1505] = "synaser.ESynaSerError.ErrorMessage^synaser.ESynaSerError.html#ErrorMessage^^ ^0" +s[1506] = "synaser.TBlockSerial^synaser.TBlockSerial.html^Main class implementing all communication routines^ ^0" +s[1507] = "synaser.TBlockSerial.DCB^synaser.TBlockSerial.html#DCB^^data Control Block with communication parameters. Usable only when you need to call API directly. ^0" +s[1508] = "synaser.TBlockSerial.Create^synaser.TBlockSerial.html#Create^^Object constructor. ^0" +s[1509] = "synaser.TBlockSerial.Destroy^synaser.TBlockSerial.html#Destroy^^Object destructor. ^0" +s[1510] = "synaser.TBlockSerial.GetVersion^synaser.TBlockSerial.html#GetVersion^^Returns a string containing the version number of the library. ^0" +s[1511] = "synaser.TBlockSerial.CloseSocket^synaser.TBlockSerial.html#CloseSocket^^Destroy handle in use. It close connection to serial port. ^0" +s[1512] = "synaser.TBlockSerial.Config^synaser.TBlockSerial.html#Config^^Reconfigure communication parameters on the fly. You must be connected to port before! baud Define connection speed. Baud rate can be from 50 to 4000000 bits per second. (it depends on your hardware!) bits Number of bits in communication. parity Define communication parity (N - None, O - Odd, E - Even, M - Mark or S - Space). stop Define number of stopbits. Use constants SB1, SB1andHalf and SB2. softflow Enable XON/XOFF handshake. hardflow Enable CTS/RTS handshake. ^0" +s[1513] = "synaser.TBlockSerial.Connect^synaser.TBlockSerial.html#Connect^^Connects to the port indicated by comport. Comport can be used in Windows style (COM2), or in Linux style (/dev/ttyS1). When you use windows style in Linux, then it will be converted to Linux name. And vice versa! However you can specify any device name! (other device names then standart is not converted!)

After successfull connection the DTR signal is set (if you not set hardware handshake, then the RTS signal is set, too!)

Connection parameters is predefined by your system configuration. If you need use another parameters, then you can use Config method after. Notes:

- Remember, the commonly used serial Laplink cable does not support hardware handshake.

- Before setting any handshake you must be sure that it is supported by your hardware.

- Some serial devices are slow. In some cases you must wait up to a few seconds after connection for the device to respond.

- when you connect to a modem device, then is best to test it by an empty AT command. (call ATCommand('AT')) ^0" +s[1514] = "synaser.TBlockSerial.SetCommState^synaser.TBlockSerial.html#SetCommState^^Set communication parameters from the DCB structure (the DCB structure is simulated under Linux). ^0" +s[1515] = "synaser.TBlockSerial.GetCommState^synaser.TBlockSerial.html#GetCommState^^Read communication parameters into the DCB structure (DCB structure is simulated under Linux). ^0" +s[1516] = "synaser.TBlockSerial.SendBuffer^synaser.TBlockSerial.html#SendBuffer^^Sends Length bytes of data from Buffer through the connected port. ^0" +s[1517] = "synaser.TBlockSerial.SendByte^synaser.TBlockSerial.html#SendByte^^One data BYTE is sent. ^0" +s[1518] = "synaser.TBlockSerial.SendString^synaser.TBlockSerial.html#SendString^^Send the string in the data parameter. No terminator is appended by this method. If you need to send a string with CR/LF terminator, you must append the CR/LF characters to the data string!

Since no terminator is appended, you can use this function for sending binary data too. ^0" +s[1519] = "synaser.TBlockSerial.SendInteger^synaser.TBlockSerial.html#SendInteger^^send four bytes as integer. ^0" +s[1520] = "synaser.TBlockSerial.SendBlock^synaser.TBlockSerial.html#SendBlock^^send data as one block. Each block begins with integer value with Length of block. ^0" +s[1521] = "synaser.TBlockSerial.SendStreamRaw^synaser.TBlockSerial.html#SendStreamRaw^^send content of stream from current position ^0" +s[1522] = "synaser.TBlockSerial.SendStream^synaser.TBlockSerial.html#SendStream^^send content of stream as block. see SendBlock ^0" +s[1523] = "synaser.TBlockSerial.SendStreamIndy^synaser.TBlockSerial.html#SendStreamIndy^^send content of stream as block, but this is compatioble with Indy library. (it have swapped lenght of block). See SendStream ^0" +s[1524] = "synaser.TBlockSerial.RecvBuffer^synaser.TBlockSerial.html#RecvBuffer^^Waits until the allocated buffer is filled by received data. Returns number of data bytes received, which equals to the Length value under normal operation. If it is not equal, the communication channel is possibly broken.

This method not using any internal buffering, like all others receiving methods. You cannot freely combine this method with all others receiving methods! ^0" +s[1525] = "synaser.TBlockSerial.RecvBufferEx^synaser.TBlockSerial.html#RecvBufferEx^^Method waits until data is received. If no data is received within the Timeout (in milliseconds) period, LastError is set to ErrTimeout. This method is used to read any amount of data (e. g. 1MB), and may be freely combined with all receviving methods what have Timeout parameter, like the Recvstring, RecvByte or RecvTerminated methods. ^0" +s[1526] = "synaser.TBlockSerial.RecvBufferStr^synaser.TBlockSerial.html#RecvBufferStr^^It is like recvBufferEx, but data is readed to dynamicly allocated binary string. ^0" +s[1527] = "synaser.TBlockSerial.RecvPacket^synaser.TBlockSerial.html#RecvPacket^^Read all available data and return it in the function result string. This function may be combined with Recvstring, RecvByte or related methods. ^0" +s[1528] = "synaser.TBlockSerial.RecvByte^synaser.TBlockSerial.html#RecvByte^^Waits until one data byte is received which is returned as the function result. If no data is received within the Timeout (in milliseconds) period, LastError is set to ErrTimeout. ^0" +s[1529] = "synaser.TBlockSerial.RecvTerminated^synaser.TBlockSerial.html#RecvTerminated^^This method waits until a terminated data string is received. This string is terminated by the Terminator string. The resulting string is returned without this termination string! If no data is received within the Timeout (in milliseconds) period, LastError is set to ErrTimeout. ^0" +s[1530] = "synaser.TBlockSerial.Recvstring^synaser.TBlockSerial.html#Recvstring^^This method waits until a terminated data string is received. The string is terminated by a CR/LF sequence. The resulting string is returned without the terminator (CR/LF)! If no data is received within the Timeout (in milliseconds) period, LastError is set to ErrTimeout.

If ConvertLineEnd is used, then the CR/LF sequence may not be exactly CR/LF. See the description of ConvertLineEnd.

This method serves for line protocol implementation and uses its own buffers to maximize performance. Therefore do NOT use this method with the RecvBuffer method to receive data as it may cause data loss. ^0" +s[1531] = "synaser.TBlockSerial.RecvInteger^synaser.TBlockSerial.html#RecvInteger^^Waits until four data bytes are received which is returned as the function integer result. If no data is received within the Timeout (in milliseconds) period, LastError is set to ErrTimeout. ^0" +s[1532] = "synaser.TBlockSerial.RecvBlock^synaser.TBlockSerial.html#RecvBlock^^Waits until one data block is received. See SendBlock. If no data is received within the Timeout (in milliseconds) period, LastError is set to ErrTimeout. ^0" +s[1533] = "synaser.TBlockSerial.RecvStreamRaw^synaser.TBlockSerial.html#RecvStreamRaw^^Receive all data to stream, until some error occured. (for example timeout) ^0" +s[1534] = "synaser.TBlockSerial.RecvStreamSize^synaser.TBlockSerial.html#RecvStreamSize^^receive requested count of bytes to stream ^0" +s[1535] = "synaser.TBlockSerial.RecvStream^synaser.TBlockSerial.html#RecvStream^^receive block of data to stream. (Data can be sended by SendStream ^0" +s[1536] = "synaser.TBlockSerial.RecvStreamIndy^synaser.TBlockSerial.html#RecvStreamIndy^^receive block of data to stream. (Data can be sended by SendStreamIndy ^0" +s[1537] = "synaser.TBlockSerial.WaitingData^synaser.TBlockSerial.html#WaitingData^^Returns the number of received bytes waiting for reading. 0 is returned when there is no data waiting. ^0" +s[1538] = "synaser.TBlockSerial.WaitingDataEx^synaser.TBlockSerial.html#WaitingDataEx^^Same as WaitingData, but in respect to data in the internal LineBuffer. ^0" +s[1539] = "synaser.TBlockSerial.SendingData^synaser.TBlockSerial.html#SendingData^^Returns the number of bytes waiting to be sent in the output buffer. 0 is returned when the output buffer is empty. ^0" +s[1540] = "synaser.TBlockSerial.EnableRTSToggle^synaser.TBlockSerial.html#EnableRTSToggle^^Enable or disable RTS driven communication (half-duplex). It can be used to communicate with RS485 converters, or other special equipment. If you enable this feature, the system automatically controls the RTS signal.

Notes:

- On Windows NT (or higher) ir RTS signal driven by system driver.

- On Win9x family is used special code for waiting until last byte is sended from your UART.

- On Linux you must have kernel 2.1 or higher! ^0" +s[1541] = "synaser.TBlockSerial.Flush^synaser.TBlockSerial.html#Flush^^Waits until all data to is sent and buffers are emptied. Warning: On Windows systems is this method returns when all buffers are flushed to the serial port controller, before the last byte is sent! ^0" +s[1542] = "synaser.TBlockSerial.Purge^synaser.TBlockSerial.html#Purge^^Unconditionally empty all buffers. It is good when you need to interrupt communication and for cleanups. ^0" +s[1543] = "synaser.TBlockSerial.CanRead^synaser.TBlockSerial.html#CanRead^^Returns True, if you can from read any data from the port. Status is tested for a period of time given by the Timeout parameter (in milliseconds). If the value of the Timeout parameter is 0, the status is tested only once and the function returns immediately. If the value of the Timeout parameter is set to -1, the function returns only after it detects data on the port (this may cause the process to hang). ^0" +s[1544] = "synaser.TBlockSerial.CanWrite^synaser.TBlockSerial.html#CanWrite^^Returns True, if you can write any data to the port (this function is not sending the contents of the buffer). Status is tested for a period of time given by the Timeout parameter (in milliseconds). If the value of the Timeout parameter is 0, the status is tested only once and the function returns immediately. If the value of the Timeout parameter is set to -1, the function returns only after it detects that it can write data to the port (this may cause the process to hang). ^0" +s[1545] = "synaser.TBlockSerial.CanReadEx^synaser.TBlockSerial.html#CanReadEx^^Same as CanRead, but the test is against data in the internal LineBuffer too. ^0" +s[1546] = "synaser.TBlockSerial.ModemStatus^synaser.TBlockSerial.html#ModemStatus^^Returns the status word of the modem. Decoding the status word could yield the status of carrier detect signaland other signals. This method is used internally by the modem status reading properties. You usually do not need to call this method directly. ^0" +s[1547] = "synaser.TBlockSerial.SetBreak^synaser.TBlockSerial.html#SetBreak^^Send a break signal to the communication device for Duration milliseconds. ^0" +s[1548] = "synaser.TBlockSerial.ATCommand^synaser.TBlockSerial.html#ATCommand^^This function is designed to send AT commands to the modem. The AT command is sent in the Value parameter and the response is returned in the function return value (may contain multiple lines!). If the AT command is processed successfully (modem returns OK), then the ATResult property is set to True.

This function is designed only for AT commands that return OK or ERROR response! To call connection commands the ATConnect method. Remember, when you connect to a modem device, it is in AT command mode. Now you can send AT commands to the modem. If you need to transfer data to the modem on the other side of the line, you must first switch to data mode using the ATConnect method. ^0" +s[1549] = "synaser.TBlockSerial.ATConnect^synaser.TBlockSerial.html#ATConnect^^This function is used to send connect type AT commands to the modem. It is for commands to switch to connected state. (ATD, ATA, ATO,...) It sends the AT command in the Value parameter and returns the modem's response (may be multiple lines - usually with connection parameters info). If the AT command is processed successfully (the modem returns CONNECT), then the ATResult property is set to True.

This function is designed only for AT commands which respond by CONNECT, BUSY, NO DIALTONE NO CARRIER or ERROR. For other AT commands use the ATCommand method.

The connect timeout is 90*AtTimeout. If this command is successful (ATResult is True), then the modem is in data state. When you now send or receive some data, it is not to or from your modem, but from the modem on other side of the line. Now you can transfer your data. If the connection attempt failed (ATResult is False), then the modem is still in AT command mode. ^0" +s[1550] = "synaser.TBlockSerial.SerialCheck^synaser.TBlockSerial.html#SerialCheck^^If you "manually" call API functions, forward their return code in the SerialResult parameter to this function, which evaluates it and sets LastError and LastErrorDesc. ^0" +s[1551] = "synaser.TBlockSerial.ExceptCheck^synaser.TBlockSerial.html#ExceptCheck^^If LastError is not 0 and exceptions are enabled, then this procedure raises an exception. This method is used internally. You may need it only in special cases. ^0" +s[1552] = "synaser.TBlockSerial.SetSynaError^synaser.TBlockSerial.html#SetSynaError^^Set Synaser to error state with ErrNumber code. Usually used by internal routines. ^0" +s[1553] = "synaser.TBlockSerial.RaiseSynaError^synaser.TBlockSerial.html#RaiseSynaError^^Raise Synaser error with ErrNumber code. Usually used by internal routines. ^0" +s[1554] = "synaser.TBlockSerial.GetErrorDesc^synaser.TBlockSerial.html#GetErrorDesc^^Returns the descriptive text associated with ErrorCode. You need this method only in special cases. Description of LastError is now accessible through the LastErrorDesc property. ^0" +s[1555] = "synaser.TBlockSerial.Device^synaser.TBlockSerial.html#Device^^True device name of currently used port ^0" +s[1556] = "synaser.TBlockSerial.LastError^synaser.TBlockSerial.html#LastError^^Error code of last operation. Value is defined by the host operating system, but value 0 is always OK. ^0" +s[1557] = "synaser.TBlockSerial.LastErrorDesc^synaser.TBlockSerial.html#LastErrorDesc^^Human readable description of LastError code. ^0" +s[1558] = "synaser.TBlockSerial.ATResult^synaser.TBlockSerial.html#ATResult^^Indicates if the last ATCommand or ATConnect method was successful ^0" +s[1559] = "synaser.TBlockSerial.RTS^synaser.TBlockSerial.html#RTS^^Read the value of the RTS signal. ^0" +s[1560] = "synaser.TBlockSerial.CTS^synaser.TBlockSerial.html#CTS^^Indicates the presence of the CTS signal ^0" +s[1561] = "synaser.TBlockSerial.DTR^synaser.TBlockSerial.html#DTR^^Use this property to set the value of the DTR signal. ^0" +s[1562] = "synaser.TBlockSerial.DSR^synaser.TBlockSerial.html#DSR^^Exposes the status of the DSR signal. ^0" +s[1563] = "synaser.TBlockSerial.Carrier^synaser.TBlockSerial.html#Carrier^^Indicates the presence of the Carrier signal ^0" +s[1564] = "synaser.TBlockSerial.Ring^synaser.TBlockSerial.html#Ring^^Reflects the status of the Ring signal. ^0" +s[1565] = "synaser.TBlockSerial.InstanceActive^synaser.TBlockSerial.html#InstanceActive^^indicates if this instance of SynaSer is active. (Connected to some port) ^0" +s[1566] = "synaser.TBlockSerial.MaxSendBandwidth^synaser.TBlockSerial.html#MaxSendBandwidth^^Defines maximum bandwidth for all sending operations in bytes per second. If this value is set to 0 (default), bandwidth limitation is not used. ^0" +s[1567] = "synaser.TBlockSerial.MaxRecvBandwidth^synaser.TBlockSerial.html#MaxRecvBandwidth^^Defines maximum bandwidth for all receiving operations in bytes per second. If this value is set to 0 (default), bandwidth limitation is not used. ^0" +s[1568] = "synaser.TBlockSerial.MaxBandwidth^synaser.TBlockSerial.html#MaxBandwidth^^Defines maximum bandwidth for all sending and receiving operations in bytes per second. If this value is set to 0 (default), bandwidth limitation is not used. ^0" +s[1569] = "synaser.TBlockSerial.SizeRecvBuffer^synaser.TBlockSerial.html#SizeRecvBuffer^^Size of the Windows internal receive buffer. Default value is usually 4096 bytes. Note: Valid only in Windows versions! ^0" +s[1570] = "synaser.TBlockSerial.Tag^synaser.TBlockSerial.html#Tag^^Freely usable property ^0" +s[1571] = "synaser.TBlockSerial.Handle^synaser.TBlockSerial.html#Handle^^Contains the handle of the open communication port. You may need this value to directly call communication functions outside SynaSer. ^0" +s[1572] = "synaser.TBlockSerial.LineBuffer^synaser.TBlockSerial.html#LineBuffer^^Internally used read buffer. ^0" +s[1573] = "synaser.TBlockSerial.RaiseExcept^synaser.TBlockSerial.html#RaiseExcept^^If True, communication errors raise exceptions. If False (default), only the LastError value is set. ^0" +s[1574] = "synaser.TBlockSerial.OnStatus^synaser.TBlockSerial.html#OnStatus^^This event is triggered when the communication status changes. It can be used to monitor communication status. ^0" +s[1575] = "synaser.TBlockSerial.TestDSR^synaser.TBlockSerial.html#TestDSR^^If you set this property to True, then the value of the DSR signal is tested before every data transfer. It can be used to detect the presence of a communications device. ^0" +s[1576] = "synaser.TBlockSerial.TestCTS^synaser.TBlockSerial.html#TestCTS^^If you set this property to True, then the value of the CTS signal is tested before every data transfer. It can be used to detect the presence of a communications device. Warning: This property cannot be used if you need hardware handshake! ^0" +s[1577] = "synaser.TBlockSerial.MaxLineLength^synaser.TBlockSerial.html#MaxLineLength^^Use this property you to limit the maximum size of LineBuffer (as a protection against unlimited memory allocation for LineBuffer). Default value is 0 - no limit. ^0" +s[1578] = "synaser.TBlockSerial.DeadlockTimeout^synaser.TBlockSerial.html#DeadlockTimeout^^This timeout value is used as deadlock protection when trying to send data to (or receive data from) a device that stopped communicating during data transmission (e.g. by physically disconnecting the device). The timeout value is in milliseconds. The default value is 30,000 (30 seconds). ^0" +s[1579] = "synaser.TBlockSerial.LinuxLock^synaser.TBlockSerial.html#LinuxLock^^If set to True (default value), port locking is enabled (under Linux only). WARNING: To use this feature, the application must run by a user with full permission to the /var/lock directory! ^0" +s[1580] = "synaser.TBlockSerial.ConvertLineEnd^synaser.TBlockSerial.html#ConvertLineEnd^^Indicates if non-standard line terminators should be converted to a CR/LF pair (standard DOS line terminator). If True, line terminators CR, single LF or LF/CR are converted to CR/LF. Defaults to False. This property has effect only on the behavior of the RecvString method. ^0" +s[1581] = "synaser.TBlockSerial.AtTimeout^synaser.TBlockSerial.html#AtTimeout^^Timeout for AT modem based operations ^0" +s[1582] = "synaser.TBlockSerial.InterPacketTimeout^synaser.TBlockSerial.html#InterPacketTimeout^^If True (default), then all timeouts is timeout between two characters. If False, then timeout is overall for whoole reading operation. ^0" +s[1583] = "synaser.CR^synaser.html#CR^^ ^0" +s[1584] = "synaser.LF^synaser.html#LF^^ ^0" +s[1585] = "synaser.CRLF^synaser.html#CRLF^^ ^0" +s[1586] = "synaser.cSerialChunk^synaser.html#cSerialChunk^^ ^0" +s[1587] = "synaser.LockfileDirectory^synaser.html#LockfileDirectory^^ ^0" +s[1588] = "synaser.PortIsClosed^synaser.html#PortIsClosed^^ ^0" +s[1589] = "synaser.ErrAlreadyOwned^synaser.html#ErrAlreadyOwned^^ ^0" +s[1590] = "synaser.ErrAlreadyInUse^synaser.html#ErrAlreadyInUse^^ ^0" +s[1591] = "synaser.ErrWrongParameter^synaser.html#ErrWrongParameter^^ ^0" +s[1592] = "synaser.ErrPortNotOpen^synaser.html#ErrPortNotOpen^^ ^0" +s[1593] = "synaser.ErrNoDeviceAnswer^synaser.html#ErrNoDeviceAnswer^^ ^0" +s[1594] = "synaser.ErrMaxBuffer^synaser.html#ErrMaxBuffer^^ ^0" +s[1595] = "synaser.ErrTimeout^synaser.html#ErrTimeout^^ ^0" +s[1596] = "synaser.ErrNotRead^synaser.html#ErrNotRead^^ ^0" +s[1597] = "synaser.ErrFrame^synaser.html#ErrFrame^^ ^0" +s[1598] = "synaser.ErrOverrun^synaser.html#ErrOverrun^^ ^0" +s[1599] = "synaser.ErrRxOver^synaser.html#ErrRxOver^^ ^0" +s[1600] = "synaser.ErrRxParity^synaser.html#ErrRxParity^^ ^0" +s[1601] = "synaser.ErrTxFull^synaser.html#ErrTxFull^^ ^0" +s[1602] = "synaser.dcb_Binary^synaser.html#dcb_Binary^^ ^0" +s[1603] = "synaser.dcb_ParityCheck^synaser.html#dcb_ParityCheck^^ ^0" +s[1604] = "synaser.dcb_OutxCtsFlow^synaser.html#dcb_OutxCtsFlow^^ ^0" +s[1605] = "synaser.dcb_OutxDsrFlow^synaser.html#dcb_OutxDsrFlow^^ ^0" +s[1606] = "synaser.dcb_DtrControlMask^synaser.html#dcb_DtrControlMask^^ ^0" +s[1607] = "synaser.dcb_DtrControlDisable^synaser.html#dcb_DtrControlDisable^^ ^0" +s[1608] = "synaser.dcb_DtrControlEnable^synaser.html#dcb_DtrControlEnable^^ ^0" +s[1609] = "synaser.dcb_DtrControlHandshake^synaser.html#dcb_DtrControlHandshake^^ ^0" +s[1610] = "synaser.dcb_DsrSensivity^synaser.html#dcb_DsrSensivity^^ ^0" +s[1611] = "synaser.dcb_TXContinueOnXoff^synaser.html#dcb_TXContinueOnXoff^^ ^0" +s[1612] = "synaser.dcb_OutX^synaser.html#dcb_OutX^^ ^0" +s[1613] = "synaser.dcb_InX^synaser.html#dcb_InX^^ ^0" +s[1614] = "synaser.dcb_ErrorChar^synaser.html#dcb_ErrorChar^^ ^0" +s[1615] = "synaser.dcb_NullStrip^synaser.html#dcb_NullStrip^^ ^0" +s[1616] = "synaser.dcb_RtsControlMask^synaser.html#dcb_RtsControlMask^^ ^0" +s[1617] = "synaser.dcb_RtsControlDisable^synaser.html#dcb_RtsControlDisable^^ ^0" +s[1618] = "synaser.dcb_RtsControlEnable^synaser.html#dcb_RtsControlEnable^^ ^0" +s[1619] = "synaser.dcb_RtsControlHandshake^synaser.html#dcb_RtsControlHandshake^^ ^0" +s[1620] = "synaser.dcb_RtsControlToggle^synaser.html#dcb_RtsControlToggle^^ ^0" +s[1621] = "synaser.dcb_AbortOnError^synaser.html#dcb_AbortOnError^^ ^0" +s[1622] = "synaser.dcb_Reserveds^synaser.html#dcb_Reserveds^^ ^0" +s[1623] = "synaser.SB1^synaser.html#SB1^^stopbit value for 1 stopbit ^0" +s[1624] = "synaser.SB1andHalf^synaser.html#SB1andHalf^^stopbit value for 1.5 stopbit ^0" +s[1625] = "synaser.SB2^synaser.html#SB2^^stopbit value for 2 stopbits ^0" +s[1626] = "synaser.sOK^synaser.html#sOK^^ ^0" +s[1627] = "synaser.sErr^synaser.html#sErr^^ ^0" +s[1628] = "synaser.GetSerialPortNames^synaser.html#GetSerialPortNames^^Returns list of existing computer serial ports. Working properly only in Windows! ^0" +s[1629] = "synaser.THookSerialReason^synaser.html#THookSerialReason^^Possible status event types for THookSerialStatus HR_SerialClose HR_Connect HR_CanRead HR_CanWrite HR_ReadCount HR_WriteCount HR_Wait ^0" +s[1630] = "synaser.THookSerialStatus^synaser.html#THookSerialStatus^^procedural prototype for status event hooking ^0" +s[1631] = "synautil^synautil.html^^ ^0" +s[1632] = "synautil.TimeZoneBias^synautil.html#TimeZoneBias^^Return your timezone bias from UTC time in minutes. ^0" +s[1633] = "synautil.TimeZone^synautil.html#TimeZone^^Return your timezone bias from UTC time in string representation like "+0200". ^0" +s[1634] = "synautil.Rfc822DateTime^synautil.html#Rfc822DateTime^^Returns current time in format defined in RFC-822. Useful for SMTP messages, but other protocols use this time format as well. Results contains the timezone specification. Four digit year is used to break any Y2K concerns. (Example 'Fri, 15 Oct 1999 21:14:56 +0200') ^0" +s[1635] = "synautil.CDateTime^synautil.html#CDateTime^^Returns date and time in format defined in C compilers in format "mmm dd hh:nn:ss" ^0" +s[1636] = "synautil.SimpleDateTime^synautil.html#SimpleDateTime^^Returns date and time in format defined in format 'yymmdd hhnnss' ^0" +s[1637] = "synautil.AnsiCDateTime^synautil.html#AnsiCDateTime^^Returns date and time in format defined in ANSI C compilers in format "ddd mmm d hh:nn:ss yyyy" ^0" +s[1638] = "synautil.GetMonthNumber^synautil.html#GetMonthNumber^^Decode three-letter string with name of month to their month number. If string not match any month name, then is returned 0. For parsing are used predefined names for English, French and German and names from system locale too. ^0" +s[1639] = "synautil.GetTimeFromStr^synautil.html#GetTimeFromStr^^Return decoded time from given string. Time must be witch separator ':'. You can use "hh:mm" or "hh:mm:ss". ^0" +s[1640] = "synautil.GetDateMDYFromStr^synautil.html#GetDateMDYFromStr^^Decode string in format "m-d-y" to TDateTime type. ^0" +s[1641] = "synautil.DecodeRfcDateTime^synautil.html#DecodeRfcDateTime^^Decode various string representations of date and time to Tdatetime type. This function do all timezone corrections too! This function can decode lot of formats like:

   ddd, d mmm yyyy hh:mm:ss   ddd, d mmm yy hh:mm:ss   ddd, mmm d yyyy hh:mm:ss   ddd mmm dd hh:mm:ss yyyy

and more with lot of modifications, include:

  Sun, 06 Nov 1994 08:49:37 GMT    ; RFC 822, updated by RFC 1123  Sunday, 06-Nov-94 08:49:37 GMT   ; RFC 850, obsoleted by RFC 1036  Sun Nov  6 08:49:37 1994         ; ANSI C

Timezone corrections known lot of symbolic timezone names (like CEST, EDT, etc.) or numeric representation (like +0200). By convention defined in RFC timezone +0000 is GMT and -0000 is current your system timezone. ^0" +s[1642] = "synautil.GetUTTime^synautil.html#GetUTTime^^Return current system date and time in UTC timezone. ^0" +s[1643] = "synautil.SetUTTime^synautil.html#SetUTTime^^Set Newdt as current system date and time in UTC timezone. This function work only if you have administrator rights! ^0" +s[1644] = "synautil.GetTick^synautil.html#GetTick^^Return current value of system timer with precizion 1 millisecond. Good for measure time difference. ^0" +s[1645] = "synautil.TickDelta^synautil.html#TickDelta^^Return difference between two timestamps. It working fine only for differences smaller then maxint. (difference must be smaller then 24 days.) ^0" +s[1646] = "synautil.CodeInt^synautil.html#CodeInt^^Return two characters, which ordinal values represents the value in byte format. (High-endian) ^0" +s[1647] = "synautil.DecodeInt^synautil.html#DecodeInt^^Decodes two characters located at "Index" offset position of the "Value" string to Word values. ^0" +s[1648] = "synautil.CodeLongInt^synautil.html#CodeLongInt^^Return four characters, which ordinal values represents the value in byte format. (High-endian) ^0" +s[1649] = "synautil.DecodeLongInt^synautil.html#DecodeLongInt^^Decodes four characters located at "Index" offset position of the "Value" string to LongInt values. ^0" +s[1650] = "synautil.DumpStr^synautil.html#DumpStr^^Dump binary buffer stored in a string to a result string. ^0" +s[1651] = "synautil.DumpExStr^synautil.html#DumpExStr^^Dump binary buffer stored in a string to a result string. All bytes with code of character is written as character, not as hexadecimal value. ^0" +s[1652] = "synautil.Dump^synautil.html#Dump^^Dump binary buffer stored in a string to a file with DumpFile filename. ^0" +s[1653] = "synautil.DumpEx^synautil.html#DumpEx^^Dump binary buffer stored in a string to a file with DumpFile filename. All bytes with code of character is written as character, not as hexadecimal value. ^0" +s[1654] = "synautil.TrimSPLeft^synautil.html#TrimSPLeft^^Like TrimLeft, but remove only spaces, not control characters! ^0" +s[1655] = "synautil.TrimSPRight^synautil.html#TrimSPRight^^Like TrimRight, but remove only spaces, not control characters! ^0" +s[1656] = "synautil.TrimSP^synautil.html#TrimSP^^Like Trim, but remove only spaces, not control characters! ^0" +s[1657] = "synautil.SeparateLeft^synautil.html#SeparateLeft^^Returns a portion of the "Value" string located to the left of the "Delimiter" string. If a delimiter is not found, results is original string. ^0" +s[1658] = "synautil.SeparateRight^synautil.html#SeparateRight^^Returns the portion of the "Value" string located to the right of the "Delimiter" string. If a delimiter is not found, results is original string. ^0" +s[1659] = "synautil.GetParameter^synautil.html#GetParameter^^Returns parameter value from string in format: parameter1="value1"; parameter2=value2 ^0" +s[1660] = "synautil.ParseParametersEx^synautil.html#ParseParametersEx^^parse value string with elements differed by Delimiter into stringlist. ^0" +s[1661] = "synautil.ParseParameters^synautil.html#ParseParameters^^parse value string with elements differed by ';' into stringlist. ^0" +s[1662] = "synautil.IndexByBegin^synautil.html#IndexByBegin^^Index of string in stringlist with same beginning as Value is returned. ^0" +s[1663] = "synautil.GetEmailAddr^synautil.html#GetEmailAddr^^Returns only the e-mail portion of an address from the full address format. i.e. returns 'nobody@somewhere.com' from '"someone" <nobody@somewhere.com>' ^0" +s[1664] = "synautil.GetEmailDesc^synautil.html#GetEmailDesc^^Returns only the description part from a full address format. i.e. returns 'someone' from '"someone" <nobody@somewhere.com>' ^0" +s[1665] = "synautil.StrToHex^synautil.html#StrToHex^^Returns a string with hexadecimal digits representing the corresponding values of the bytes found in "Value" string. ^0" +s[1666] = "synautil.IntToBin^synautil.html#IntToBin^^Returns a string of binary "Digits" representing "Value". ^0" +s[1667] = "synautil.BinToInt^synautil.html#BinToInt^^Returns an integer equivalent of the binary string in "Value". (i.e. ('10001010') returns 138) ^0" +s[1668] = "synautil.ParseURL^synautil.html#ParseURL^^Parses a URL to its various components. ^0" +s[1669] = "synautil.ReplaceString^synautil.html#ReplaceString^^Replaces all "Search" string values found within "Value" string, with the "Replace" string value. ^0" +s[1670] = "synautil.RPosEx^synautil.html#RPosEx^^It is like RPos, but search is from specified possition. ^0" +s[1671] = "synautil.RPos^synautil.html#RPos^^It is like POS function, but from right side of Value string. ^0" +s[1672] = "synautil.FetchBin^synautil.html#FetchBin^^Like Fetch, but working with binary strings, not with text. ^0" +s[1673] = "synautil.Fetch^synautil.html#Fetch^^Fetch string from left of Value string. ^0" +s[1674] = "synautil.FetchEx^synautil.html#FetchEx^^Fetch string from left of Value string. This function ignore delimitesr inside quotations. ^0" +s[1675] = "synautil.IsBinaryString^synautil.html#IsBinaryString^^If string is binary string (contains non-printable characters), then is returned true. ^0" +s[1676] = "synautil.PosCRLF^synautil.html#PosCRLF^^return position of string terminator in string. If terminator found, then is returned in terminator parameter. Possible line terminators are: CRLF, LFCR, CR, LF ^0" +s[1677] = "synautil.StringsTrim^synautil.html#StringsTrim^^Delete empty strings from end of stringlist. ^0" +s[1678] = "synautil.PosFrom^synautil.html#PosFrom^^Like Pos function, buf from given string possition. ^0" +s[1679] = "synautil.IncPoint^synautil.html#IncPoint^^Increase pointer by value. ^0" +s[1680] = "synautil.GetBetween^synautil.html#GetBetween^^Get string between PairBegin and PairEnd. This function respect nesting. For example:

   Value is: 'Hi! (hello(yes!))'   pairbegin is: '('   pairend is: ')'   In this case result is: 'hello(yes!)'

^0" +s[1681] = "synautil.CountOfChar^synautil.html#CountOfChar^^Return count of Chr in Value string. ^0" +s[1682] = "synautil.UnquoteStr^synautil.html#UnquoteStr^^Remove quotation from Value string. If Value is not quoted, then return same string without any modification. ^0" +s[1683] = "synautil.QuoteStr^synautil.html#QuoteStr^^Quote Value string. If Value contains some Quote chars, then it is doubled. ^0" +s[1684] = "synautil.HeadersToList^synautil.html#HeadersToList^^Convert lines in stringlist from 'name: value' form to 'name=value' form. ^0" +s[1685] = "synautil.ListToHeaders^synautil.html#ListToHeaders^^Convert lines in stringlist from 'name=value' form to 'name: value' form. ^0" +s[1686] = "synautil.SwapBytes^synautil.html#SwapBytes^^swap bytes in integer. ^0" +s[1687] = "synautil.ReadStrFromStream^synautil.html#ReadStrFromStream^^read string with requested length form stream. ^0" +s[1688] = "synautil.WriteStrToStream^synautil.html#WriteStrToStream^^write string to stream. ^0" +s[1689] = "synautil.GetTempFile^synautil.html#GetTempFile^^Return filename of new temporary file in Dir (if empty, then default temporary directory is used) and with optional filename prefix. ^0" +s[1690] = "synautil.PadString^synautil.html#PadString^^Return padded string. If length is greater, string is truncated. If length is smaller, string is padded by Pad character. ^0" +s[1691] = "synautil.XorString^synautil.html#XorString^^XOR each byte in the strings ^0" +s[1692] = "synautil.NormalizeHeader^synautil.html#NormalizeHeader^^Read header from "Value" stringlist beginning at "Index" position. If header is Splitted into multiple lines, then this procedure de-split it into one line. ^0" +s[1693] = "synautil.SearchForLineBreak^synautil.html#SearchForLineBreak^^Search for one of line terminators CR, LF or NUL. Return position of the line beginning and length of text. ^0" +s[1694] = "synautil.SkipLineBreak^synautil.html#SkipLineBreak^^Skip both line terminators CR LF (if any). Move APtr position forward. ^0" +s[1695] = "synautil.SkipNullLines^synautil.html#SkipNullLines^^Skip all blank lines in a buffer starting at APtr and move APtr position forward. ^0" +s[1696] = "synautil.CopyLinesFromStreamUntilNullLine^synautil.html#CopyLinesFromStreamUntilNullLine^^Copy all lines from a buffer starting at APtr to ALines until empty line or end of the buffer is reached. Move APtr position forward). ^0" +s[1697] = "synautil.CopyLinesFromStreamUntilBoundary^synautil.html#CopyLinesFromStreamUntilBoundary^^Copy all lines from a buffer starting at APtr to ALines until ABoundary or end of the buffer is reached. Move APtr position forward). ^0" +s[1698] = "synautil.SearchForBoundary^synautil.html#SearchForBoundary^^Search ABoundary in a buffer starting at APtr. Return beginning of the ABoundary. Move APtr forward behind a trailing CRLF if any). ^0" +s[1699] = "synautil.MatchBoundary^synautil.html#MatchBoundary^^Compare a text at position ABOL with ABoundary and return position behind the match (including a trailing CRLF if any). ^0" +s[1700] = "synautil.MatchLastBoundary^synautil.html#MatchLastBoundary^^Compare a text at position ABOL with ABoundary + the last boundary suffix and return position behind the match (including a trailing CRLF if any). ^0" +s[1701] = "synautil.BuildStringFromBuffer^synautil.html#BuildStringFromBuffer^^Copy data from a buffer starting at position APtr and delimited by AEtx position into ANSIString. ^0" +s[1702] = "synautil.CustomMonthNames^synautil.html#CustomMonthNames^^can be used for your own months strings for GetMonthNumber ^0" +s[1703] = "tlntsend^tlntsend.html^Telnet script client^

Used RFC: RFC-854 ^0" +s[1704] = "tlntsend.TTelnetSend^tlntsend.TTelnetSend.html^Class with implementation of Telnet/SSH script client.^

Note: Are you missing properties for specify server address and port? Look to parent TSynaClient too! ^0" +s[1705] = "tlntsend.TTelnetSend.Create^tlntsend.TTelnetSend.html#Create^^ ^0" +s[1706] = "tlntsend.TTelnetSend.Destroy^tlntsend.TTelnetSend.html#Destroy^^ ^0" +s[1707] = "tlntsend.TTelnetSend.Login^tlntsend.TTelnetSend.html#Login^^Connects to Telnet server. ^0" +s[1708] = "tlntsend.TTelnetSend.SSHLogin^tlntsend.TTelnetSend.html#SSHLogin^^Connects to SSH2 server and login by Username and Password properties.

You must use some of SSL plugins with SSH support. For exammple CryptLib. ^0" +s[1709] = "tlntsend.TTelnetSend.Logout^tlntsend.TTelnetSend.html#Logout^^Logout from telnet server. ^0" +s[1710] = "tlntsend.TTelnetSend.Send^tlntsend.TTelnetSend.html#Send^^Send this data to telnet server. ^0" +s[1711] = "tlntsend.TTelnetSend.WaitFor^tlntsend.TTelnetSend.html#WaitFor^^Reading data from telnet server until Value is readed. If it is not readed until timeout, result is False. Otherwise result is True. ^0" +s[1712] = "tlntsend.TTelnetSend.RecvTerminated^tlntsend.TTelnetSend.html#RecvTerminated^^Read data terminated by terminator from telnet server. ^0" +s[1713] = "tlntsend.TTelnetSend.RecvString^tlntsend.TTelnetSend.html#RecvString^^Read string from telnet server. ^0" +s[1714] = "tlntsend.TTelnetSend.Sock^tlntsend.TTelnetSend.html#Sock^^Socket object used for TCP/IP operation. Good for seting OnStatus hook, etc. ^0" +s[1715] = "tlntsend.TTelnetSend.SessionLog^tlntsend.TTelnetSend.html#SessionLog^^all readed datas in this session (from connect) is stored in this large string. ^0" +s[1716] = "tlntsend.TTelnetSend.TermType^tlntsend.TTelnetSend.html#TermType^^Terminal type indentification. By default is 'SYNAPSE'. ^0" +s[1717] = "tlntsend.cTelnetProtocol^tlntsend.html#cTelnetProtocol^^ ^0" +s[1718] = "tlntsend.cSSHProtocol^tlntsend.html#cSSHProtocol^^ ^0" +s[1719] = "tlntsend.TLNT_EOR^tlntsend.html#TLNT_EOR^^ ^0" +s[1720] = "tlntsend.TLNT_SE^tlntsend.html#TLNT_SE^^ ^0" +s[1721] = "tlntsend.TLNT_NOP^tlntsend.html#TLNT_NOP^^ ^0" +s[1722] = "tlntsend.TLNT_DATA_MARK^tlntsend.html#TLNT_DATA_MARK^^ ^0" +s[1723] = "tlntsend.TLNT_BREAK^tlntsend.html#TLNT_BREAK^^ ^0" +s[1724] = "tlntsend.TLNT_IP^tlntsend.html#TLNT_IP^^ ^0" +s[1725] = "tlntsend.TLNT_AO^tlntsend.html#TLNT_AO^^ ^0" +s[1726] = "tlntsend.TLNT_AYT^tlntsend.html#TLNT_AYT^^ ^0" +s[1727] = "tlntsend.TLNT_EC^tlntsend.html#TLNT_EC^^ ^0" +s[1728] = "tlntsend.TLNT_EL^tlntsend.html#TLNT_EL^^ ^0" +s[1729] = "tlntsend.TLNT_GA^tlntsend.html#TLNT_GA^^ ^0" +s[1730] = "tlntsend.TLNT_SB^tlntsend.html#TLNT_SB^^ ^0" +s[1731] = "tlntsend.TLNT_WILL^tlntsend.html#TLNT_WILL^^ ^0" +s[1732] = "tlntsend.TLNT_WONT^tlntsend.html#TLNT_WONT^^ ^0" +s[1733] = "tlntsend.TLNT_DO^tlntsend.html#TLNT_DO^^ ^0" +s[1734] = "tlntsend.TLNT_DONT^tlntsend.html#TLNT_DONT^^ ^0" +s[1735] = "tlntsend.TLNT_IAC^tlntsend.html#TLNT_IAC^^ ^0" +s[1736] = "tlntsend.TTelnetState^tlntsend.html#TTelnetState^State of telnet protocol^. Used internaly by TTelnetSend. tsDATA tsIAC tsIAC_SB tsIAC_WILL tsIAC_DO tsIAC_WONT tsIAC_DONT tsIAC_SBIAC tsIAC_SBDATA tsSBDATA_IAC ^0" ADDED lib/synapse/docs/help/tip_form.js Index: lib/synapse/docs/help/tip_form.js ================================================================== --- /dev/null +++ lib/synapse/docs/help/tip_form.js @@ -0,0 +1,19 @@ +// Tipue 1.63 (modified for pasdoc) + + +// ---------- script properties ---------- + + +var results_location = "_tipue_results.html"; + + +// ---------- end of script properties ---------- + + +function search_form(tip_Form) { + if (tip_Form.d.value.length > 0) { + document.cookie = 'tid=' + escape(tip_Form.d.value) + '; path=/'; + document.cookie = 'tin=0; path=/'; + parent.content.location.href = results_location; + } +} ADDED lib/synapse/docs/help/tip_search.js Index: lib/synapse/docs/help/tip_search.js ================================================================== --- /dev/null +++ lib/synapse/docs/help/tip_search.js @@ -0,0 +1,357 @@ +// Tipue 1.63 (modified for pasdoc) + + +// ---------- script properties ---------- + + +var results_location = "_tipue_results.html"; +var return_results = 10; +var include_num = 1; +var bold_query = 0; +var include_url = 0; + + +// ---------- end of script properties ---------- + + +var cookies = document.cookie; +var tp = cookies.indexOf('tid='); +var pn = cookies.indexOf('tin='); + +var lnf = 'Your search did not match any documents.

Make sure all keywords are spelled correctly.
Try different or more general keywords.'; +var lp = 'Previous '; +var ln = 'Next '; + +if (tp != -1) { + var st = tp + 4; + var en = cookies.indexOf(';', st); + if (en == -1) { + en = cookies.length; + } + var dit = cookies.substring(st, en); + dit = unescape(dit); +} +if (pn != -1) { + var st = pn + 4; + var en = cookies.indexOf(';', st); + if (en == -1) { + en = cookies.length; + } + var tn = cookies.substring(st, en); +} + +var od = dit; +var nr = return_results; +tn = parseInt(tn); +var nb = tn + nr; +var nc = 0; +var nd = 0; +var tr = new Array(); +var rt = new Array(); +var co = 0; +var tm = 0; + +if (dit.charAt(0) == '"' && dit.charAt(dit.length - 1) == '"') { + tm = 1; +} +var rn = dit.search(/ or /i); +if (rn >= 0) { + tm = 2; +} +rn = dit.search(/-/i); +if (rn >= 0 && tm != 1) { + rn = dit.search(/ /i); + if (rn != 0) { + dit = dit.replace(/-/gi, ' -'); + } +} +rn = dit.search(/ not /i); +if (rn >= 0 && tm != 1) { + dit = dit.replace(/ not /gi, ' -'); +} +rn = dit.search(/\+/i); +if (rn >= 0) { + rn = dit.search(/ /i); + if (rn != 0) { + dit = dit.replace(/\+/gi, ' +'); + } +} + +if (tm == 0) { + var woin = new Array(); + dit = dit.replace(/ and /gi, ' '); + var wt = dit.split(' '); + for (var a = 0; a < wt.length; a++) { + woin[a] = 0; + if (wt[a].charAt(0) == '-') { + woin[a] = 1; + } + } + for (var a = 0; a < wt.length; a++) { + wt[a] = wt[a].replace(/^\-|^\+/gi, ''); + } + a = 0; + for (var c = 0; c < s.length; c++) { + var es = s[c].split('^'); + var rk = 100; + if (es[5] == null) { + es[5] = '0'; + } + if (parseInt(es[5]) > 10) { + es[5] = '10'; + } + var pa = 0; + var nh = 0; + for (var i = 0; i < woin.length; i++) { + if (woin[i] == 0) { + nh++; + var nt = 0; + var pat = new RegExp(wt[i], 'i'); + rn = es[0].search(pat); + if (rn >= 0) { + rk = rk - 11; + rk = rk - parseInt(es[5]); + nt = 1; + } + rn = es[2].search(pat); + if (rn >= 0) { + rk = rk - 11; + rk = rk - parseInt(es[5]); + nt = 1; + } + rn = es[3].search(pat); + if (rn >= 0) { + rk = rk - 11; + rk = rk - parseInt(es[5]); + nt = 1; + } + if (nt == 1) { + pa++; + } + } + if (woin[i] == 1) { + var pat = new RegExp(wt[i], 'i'); + rn = es[0].search(pat); + if (rn >= 0) { + pa = 0; + } + rn = es[2].search(pat); + if (rn >= 0) { + pa = 0; + } + rn = es[3].search(pat); + if (rn >= 0) { + pa = 0; + } + } + } + if (pa == nh) { + tr[a] = rk + '^' + s[c]; + a++; + } + } + tr.sort(); + co = a; +} + +if (tm == 1) { + dit = dit.replace(/"/gi, ''); + var a = 0; + var pat = new RegExp(dit, 'i'); + for (var c = 0; c < s.length; c++) { + var es = s[c].split('^'); + var rk = 100; + if (es[5] == null) { + es[5] = '0'; + } + if (parseInt(es[5]) > 10) { + es[5] = '10'; + } + rn = es[0].search(pat); + if (rn >= 0) { + rk = rk - 11; + rk = rk - parseInt(es[5]); + } + rn = es[2].search(pat); + if (rn >= 0) { + rk = rk - 11; + rk = rk - parseInt(es[5]); + } + rn = es[3].search(pat); + if (rn >= 0) { + rk = rk - 11; + rk = rk - parseInt(es[5]); + } + if (rk < 100) { + tr[a] = rk + '^' + s[c]; + a++; + } + } + tr.sort(); + co = a; +} + +if (tm == 2) { + dit = dit.replace(/ or /gi, ' '); + var wt = dit.split(' '); + var a = 0; + for (var i = 0; i < wt.length; i++) { + var pat = new RegExp(wt[i], 'i'); + for (var c = 0; c < s.length; c++) { + var es = s[c].split('^'); + var rk = 100; + if (es[5] == null) { + es[5] = '0'; + } + if (parseInt(es[5]) > 10) { + es[5] = '10'; + } + var pa = 0; + var rn = es[0].search(pat); + if (rn >= 0) { + rk = rk - 11; + rk = rk - parseInt(es[5]); + if (rn >= 0) { + for (var e = 0; e < rt.length; e++) { + if (s[c] == rt[e]) { + pa = 1; + } + } + } + } + rn = es[2].search(pat); + if (rn >= 0) { + rk = rk - 11; + rk = rk - parseInt(es[5]); + if (rn >= 0) { + for (var e = 0; e < rt.length; e++) { + if (s[c] == rt[e]) { + pa = 1; + } + } + } + } + var rn = es[3].search(pat); + if (rn >= 0) { + rk = rk - 11; + rk = rk - parseInt(es[5]); + if (rn >= 0) { + for (var e = 0; e < rt.length; e++) { + if (s[c] == rt[e]) { + pa = 1; + } + } + } + } + if (rk < 100 && pa == 0) { + rt[a] = s[c]; + tr[a] = rk + '^' + s[c]; + a++; + co++; + } + } + } + tr.sort(); +} + +function write_cookie(nw) { + document.cookie = 'tid=' + escape(od) + '; path=/'; + document.cookie = 'tin=' + nw + '; path=/'; +} + + +// ---------- External references ---------- + + +var tip_Num = co; + +function tip_query() { + if (od != 'undefined' && od != null) document.tip_Form.d.value = od; +} + +function tip_num() { + document.write(co); +} + +function tip_out() { + if (co == 0) { + document.write(lnf); + return; + } + if (tn + nr > co) { + nd = co; + } else { + nd = tn + nr; + } + for (var a = tn; a < nd; a++) { + var os = tr[a].split('^'); + if (os[5] == null) { + os[5] = '0'; + } + if (bold_query == 1 && tm == 0) { + for (var i = 0; i < wt.length; i++) { + var lw = wt[i].length; + var tw = new RegExp(wt[i], 'i'); + rn = os[3].search(tw); + if (rn >= 0) { + var o1 = os[3].slice(0, rn); + var o2 = os[3].slice(rn, rn + lw); + var o3 = os[3].slice(rn + lw); + os[3] = o1 + '' + o2 + '' + o3; + } + } + } + if (bold_query == 1 && tm == 1) { + var lw = dit.length; + var tw = new RegExp(dit, 'i'); + rn = os[3].search(tw); + if (rn >= 0) { + var o1 = os[3].slice(0, rn); + var o2 = os[3].slice(rn, rn + lw); + var o3 = os[3].slice(rn + lw); + os[3] = o1 + '' + o2 + '' + o3; + } + } + if (include_num == 1) { + document.write(a + 1, '. '); + } + if (os[5] == '0') { + document.write('', os[1], ''); + } + if (os[5] == '1') { + document.write('', os[1], ''); + } + if (os[5] != '0' && os[5] != '1') { + document.write('', os[1], ''); + } + if (os[3].length > 1) { + document.write('
', os[3]); + } + if (include_url == 1) { + if (os[5] == '0') { + document.write('
', os[2], '

'); + } + if (os[5] == '1') { + document.write('
', os[2], '

'); + } + if (os[5] != '0' && os[5] != '1') { + document.write('
', os[2], '

'); + } + } else { + document.write('

'); + } + } + if (co > nr) { + nc = co - nb; + if (nc > nr) { + nc = nr; + } + document.write('

'); + } + if (tn > 1) { + document.write('', lp, nr, ' '); + } + if (nc > 0) { + document.write('', ln, nc, ''); + } +} ADDED lib/synapse/docs/help/tipue_b1.png Index: lib/synapse/docs/help/tipue_b1.png ================================================================== --- /dev/null +++ lib/synapse/docs/help/tipue_b1.png cannot compute difference between binary files ADDED lib/synapse/docs/help/tlntsend.TTelnetSend.html Index: lib/synapse/docs/help/tlntsend.TTelnetSend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/tlntsend.TTelnetSend.html @@ -0,0 +1,184 @@ + + + + + +tlntsend: Class TTelnetSend + + + +

Class TTelnetSend

+ + +

Fields

Unit

+tlntsend

Declaration

+type TTelnetSend = class(TSynaClient)

Description

+Class with implementation of Telnet/SSH script client.

+ + +

Note: Are you missing properties for specify server address and port? Look to parent TSynaClient too!

Hierarchy

TObject
TSynaClient
TTelnetSend

Overview

Methods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	`constructor Create;`
	`destructor Destroy; override;`
	`function Login: Boolean;`
	`function SSHLogin: Boolean;`
	`procedure Logout;`
	`procedure Send(const Value: string);`
	`function WaitFor(const Value: string): Boolean;`
	`function RecvTerminated(const Terminator: string): string;`
	`function RecvString: string;`

Properties

+ + + + + + + + + + + + + +

	`property Sock: TTCPBlockSocket read FSock;`
	`property SessionLog: Ansistring read FSessionLog write FSessionLog;`
	`property TermType: Ansistring read FTermType write FTermType;`

Description

Methods

+ + + + + +

constructor Create;

+ + + + + +

destructor Destroy; override;

+ + + + + +

function Login: Boolean;

+Connects to Telnet server.

+ + + + + +

function SSHLogin: Boolean;

+Connects to SSH2 server and login by Username and Password properties. + +

You must use some of SSL plugins with SSH support. For exammple CryptLib.

+ + + + + +

procedure Logout;

+Logout from telnet server.

+ + + + + +

procedure Send(const Value: string);

+Send this data to telnet server.

+ + + + + +

function WaitFor(const Value: string): Boolean;

+Reading data from telnet server until Value is readed. If it is not readed until timeout, result is False. Otherwise result is True.

+ + + + + +

function RecvTerminated(const Terminator: string): string;

+Read data terminated by terminator from telnet server.

+ + + + + +

function RecvString: string;

+Read string from telnet server.

Properties

+ + + + + +

property Sock: TTCPBlockSocket read FSock;

+Socket object used for TCP/IP operation. Good for seting OnStatus hook, etc.

+ + + + + +

property SessionLog: Ansistring read FSessionLog write FSessionLog;

+all readed datas in this session (from connect) is stored in this large string.

+ + + + + +

property TermType: Ansistring read FTermType write FTermType;

+Terminal type indentification. By default is 'SYNAPSE'.

Generated by PasDoc 0.9.0 on 2012-04-23 21:38:52 + + ADDED lib/synapse/docs/help/tlntsend.html Index: lib/synapse/docs/help/tlntsend.html ================================================================== --- /dev/null +++ lib/synapse/docs/help/tlntsend.html @@ -0,0 +1,231 @@ + + + + + +tlntsend + + + +

Unit tlntsend

+ + +

Functions and Procedures