\ConsumerStrategies_SocketConsumer

Consumes messages and writes them to host/endpoint using a persistent socket

Summary

Methods
Properties
Constants
__construct()
getNumThreads()
persist()
No public properties found
No constants found
_encode()
_handleError()
_log()
_debug()
$_options
N/A
_getSocket()
_createSocket()
_destroySocket()
_write()
handleResponse()
$_defaults
$_host
$_endpoint
$_connect_timeout
$_protocol
$_socket
$_async
N/A

Properties

$_options

$_options : array

An array of options to be used by the Mixpanel library.

Type

array

$_defaults

$_defaults : array

Default options that can be overridden via the $options constructor arg

Type

array

$_host

$_host : string

Type

string — the host to connect to (e.g. api.mixpanel.com)

$_endpoint

$_endpoint : string

Type

string — the host-relative endpoint to write to (e.g. /engage)

$_connect_timeout

$_connect_timeout : integer

Type

integer — connect_timeout the socket connection timeout in seconds

$_protocol

$_protocol : string

Type

string — the protocol to use for the socket connection

$_socket

$_socket : resource

Type

resource — holds the socket resource

$_async

$_async : boolean

Type

boolean — whether or not to wait for a response

Methods

__construct()

__construct(array  $options = array()) 

Creates a new SocketConsumer and assigns properties from the $options array

Parameters

array $options

getNumThreads()

getNumThreads() : integer

Number of requests/batches that will be processed in parallel.

Returns

integer

persist()

persist(array  $batch) : boolean

Write using a persistent socket connection.

Parameters

array $batch

an array of messages to consume

Returns

boolean

_encode()

_encode(array  $params) : string

Encode an array to be persisted

Parameters

array $params

Returns

string

_handleError()

_handleError(  $code,   $msg) 

Handles errors that occur in a consumer

Parameters

$code
$msg

_log()

_log(  $msg) 

Log a message to PHP's error log

Parameters

$msg

_debug()

_debug() : boolean

Returns true if in debug mode, false if in production mode

Returns

boolean

_getSocket()

_getSocket() : boolean|resource

Return cached socket if open or create a new persistent socket

Returns

boolean|resource

_createSocket()

_createSocket(boolean  $retry = true) : boolean|resource

Attempt to open a new socket connection, cache it, and return the resource

Parameters

boolean $retry

Returns

boolean|resource

_destroySocket()

_destroySocket() 

Attempt to close and dereference a socket resource

_write()

_write(  $socket,   $data, boolean  $retry = true) : boolean

Write $data through the given $socket

Parameters

$socket
$data
boolean $retry

Returns

boolean

handleResponse()

handleResponse(  $response) : array

Parse the response from a socket write (only used for debugging)

Parameters

$response

Returns

array