Docs For Class JHttpTransportSocket

Description

Implements interfaces:

JHttpTransport

HTTP transport class for using sockets directly.

since: 11.3

Located in /libraries/joomla/http/transport/socket.php (line 19)

Variable Summary

array $connections

JRegistry $options

Method Summary

static boolean isSupported ()

JHttpTransportSocket __construct (JRegistry $options)

resource connect (JUri $uri, [integer $timeout = null])

JHttpResponse getResponse (string $content)

JHttpResponse request (string $method, JUri $uri, [mixed $data = null], [array $headers = null], [integer $timeout = null], [string $userAgent = null])

Variables

array $connections (line 25)

var: Reusable socket connections.
since: 11.3
access: protected

JRegistry $options (line 31)

var: The client options.
since: 11.3
access: protected

Methods

static isSupported (line 307)

Method to check if http transport socket available for use

return: True if available else false
since: 12.1
access: public

static boolean isSupported ()

Implementation of:

JHttpTransport::isSupported(): Method to check if HTTP transport is available for use

Constructor __construct (line 41)

Constructor.

since: 11.3
throws: RuntimeException
access: public

JHttpTransportSocket __construct (JRegistry $options)

JRegistry $options: Client options object.

Implementation of:

JHttpTransport::__construct(): Constructor.

connect (line 213)

Method to connect to a server and get the resource.

return: Socket connection resource.
since: 11.3
throws: RuntimeException
access: protected

resource connect (JUri $uri, [integer $timeout = null])

JUri $uri: The URI to connect with.
integer $timeout: Read timeout in seconds.

getResponse (line 158)

Method to get a response object from a server response.

since: 11.3
throws: UnexpectedValueException
access: protected

JHttpResponse getResponse (string $content)

string $content: The complete server response, including headers.

request (line 66)

Send a request to the server and return a JHttpResponse object with the response.

since: 11.3
throws: RuntimeException
access: public

JHttpResponse request (string $method, JUri $uri, [mixed $data = null], [array $headers = null], [integer $timeout = null], [string $userAgent = null])

string $method: The HTTP method for sending the request.
JUri $uri: The URI to the resource to request.
mixed $data: Either an associative array or a string to be sent with the request.
array $headers: An array of request headers to send with the request.
integer $timeout: Read timeout in seconds.
string $userAgent: The optional user agent string to send with the request.

Implementation of:

JHttpTransport::request(): Send a request to the server and return a JHttpResponse object with the response.