Socket
Extends AbstractTransportHTTP transport class for using sockets directly.
| since |
1.0 |
|---|---|
| package |
Joomla Framework |
Methods
__construct
Constructor.
__construct(array|\ArrayAccess options = []) :
| since |
2.0.0 |
|---|---|
| throws |
|
Arguments
- options
array<string|int, mixed>|ArrayAccessClient options array.
Response
mixed
connect
Method to connect to a server and get the resource.
connect(\Joomla\Uri\UriInterface uri, timeout = null) :
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- uri
UriInterfaceThe URI to connect with.- timeout
intRead timeout in seconds.
Response
resourceSocket connection resource.
getOption
Get an option from the HTTP transport.
getOption( key, default = null) :
| since |
2.0.0 |
|---|
Arguments
- key
stringThe name of the option to get.- default
mixedThe default value if the option is not set.
Response
mixedThe option value.
getResponse
Method to get a response object from a server response.
getResponse( content) : \Joomla\Http\Response
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- content
stringThe complete server response, including headers.
Response
isSupported
Method to check if http transport socket available for use
isSupported() :
| since |
1.0 |
|---|
Response
boolTrue if available else false
processHeaders
Processes the headers from a transport's response data.
processHeaders(mixed||string|int headers) : mixed||string|int
| since |
2.0.0 |
|---|
Arguments
- headers
array<string|int, mixed>The headers to process.
Response
array<string|int, mixed>
request
Send a request to the server and return a Response object with the response.
request( method, \Joomla\Uri\UriInterface uri, data = null, mixed||string|int headers = [], timeout = null, userAgent = null) : \Joomla\Http\Response
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- method
stringThe HTTP method for sending the request.- uri
UriInterfaceThe URI to the resource to request.- data
mixedEither an associative array or a string to be sent with the request.- headers
array<string|int, mixed>An array of request headers to send with the request.- timeout
intRead timeout in seconds.- userAgent
stringThe optional user agent string to send with the request.
Response
Properties
options
The client options.
| since |
2.0.0 |
|---|
Type(s)
array<string|int, mixed>|ArrayAccess
connections
Reusable socket connections.
| since |
1.0 |
|---|
Type(s)
array<string|int, mixed>