:Connect()


Class

     aprHTTP()

 

Syntax

     :Connect(cHost,[nPort],[nTimeout],[nParams],[cnVersion] ) --> hSession

 

Parameters

cHost

String, May be a fully-qualified domain name or an IP address.

nPort

Optional: Numeric, Port that the remote Server is listening on for connections

nTimeout

Optional: Numeric. Number of Seconds to wait before resulting in a Timeout Error.

A Value of zero indicates that the process should wait indefinitely for the Server to respond.

nParams

Optional: Numeric,

cnVersion

Optional: Character or Numeric,

 

Return

     If the function succeeds, the return value is a numeric client session value which is stored in :Session.

     If the function fails the return value is HTTP_ERROR. To get further error information see :nErr and :cErr

 

Description

:Connect() is used to connect to a remote HTTP Server to process the Query.

 

nParams

 

A bitmask which specifies one or more options.

This parameter is constructed by using the adding together any of the following values:

 

HTTP_OPTION_NOCACHE

This instructs the server to not return a cached copy of the resource. When connected to an HTTP 1.0 or earlier server, this directive may be ignored.

 

HTTP_OPTION_KEEPALIVE

This instructs the server to maintain a persistent connection between requests. This can improve performance because it eliminates the need to establish a seperate connection for each resource that is requested.

If the server does not support the keep-alive option, the client will automatically reconnect when each resource is requested. Although it will not provide any performance benefits, this allows the option to be used with all servers.

 

HTTP_OPTION_SECURE

This option specifies that the client should attempt to establish a secure connection with the server. Note that the the server must support secure connections using either the SSL, PCT or TLS protocols.

This option is only available in the Secure Editions of aSocks.

 

See Also

     :Disconnect()