php-amqplib

Protocol091
in package

Table of Contents

accessRequest()  : array<string|int, mixed>
accessRequestOk()  : array<string|int, mixed>
basicAck()  : array<string|int, mixed>
basicCancel()  : array<string|int, mixed>
basicCancelOk()  : array<string|int, mixed>
basicConsume()  : array<string|int, mixed>
basicConsumeOk()  : array<string|int, mixed>
basicDeliver()  : array<string|int, mixed>
basicGet()  : array<string|int, mixed>
basicGetEmpty()  : array<string|int, mixed>
basicGetOk()  : array<string|int, mixed>
basicNack()  : array<string|int, mixed>
basicPublish()  : array<string|int, mixed>
basicQos()  : array<string|int, mixed>
Specifies QoS
basicQosOk()  : array<string|int, mixed>
basicRecover()  : array<string|int, mixed>
basicRecoverAsync()  : array<string|int, mixed>
basicRecoverOk()  : array<string|int, mixed>
basicReject()  : array<string|int, mixed>
basicReturn()  : array<string|int, mixed>
channelClose()  : array<string|int, mixed>
channelCloseOk()  : array<string|int, mixed>
channelFlow()  : array<string|int, mixed>
channelFlowOk()  : array<string|int, mixed>
channelOpen()  : array<string|int, mixed>
channelOpenOk()  : array<string|int, mixed>
confirmSelect()  : array<string|int, mixed>
confirmSelectOk()  : array<string|int, mixed>
connectionBlocked()  : array<string|int, mixed>
connectionClose()  : array<string|int, mixed>
connectionCloseOk()  : array<string|int, mixed>
connectionOpen()  : array<string|int, mixed>
connectionOpenOk()  : array<string|int, mixed>
connectionSecure()  : array<string|int, mixed>
connectionSecureOk()  : array<string|int, mixed>
connectionStart()  : array<string|int, mixed>
connectionStartOk()  : array<string|int, mixed>
connectionTune()  : array<string|int, mixed>
connectionTuneOk()  : array<string|int, mixed>
connectionUnblocked()  : array<string|int, mixed>
exchangeBind()  : array<string|int, mixed>
exchangeBindOk()  : array<string|int, mixed>
exchangeDeclare()  : array<string|int, mixed>
exchangeDeclareOk()  : array<string|int, mixed>
exchangeDelete()  : array<string|int, mixed>
exchangeDeleteOk()  : array<string|int, mixed>
exchangeUnbind()  : array<string|int, mixed>
exchangeUnbindOk()  : array<string|int, mixed>
queueBind()  : array<string|int, mixed>
queueBindOk()  : array<string|int, mixed>
queueDeclare()  : array<string|int, mixed>
queueDeclareOk()  : array<string|int, mixed>
queueDelete()  : array<string|int, mixed>
queueDeleteOk()  : array<string|int, mixed>
queuePurge()  : array<string|int, mixed>
queuePurgeOk()  : array<string|int, mixed>
queueUnbind()  : array<string|int, mixed>
queueUnbindOk()  : array<string|int, mixed>
txCommit()  : array<string|int, mixed>
txCommitOk()  : array<string|int, mixed>
txRollback()  : array<string|int, mixed>
txRollbackOk()  : array<string|int, mixed>
txSelect()  : array<string|int, mixed>
txSelectOk()  : array<string|int, mixed>

Methods

accessRequest()

public accessRequest([string $realm = '/data' ][, bool $exclusive = false ][, bool $passive = true ][, bool $active = true ][, bool $write = true ][, bool $read = true ]) : array<string|int, mixed>
Parameters
$realm : string = '/data'
$exclusive : bool = false
$passive : bool = true
$active : bool = true
$write : bool = true
$read : bool = true
Return values
array<string|int, mixed> —

accessRequestOk()

public static accessRequestOk(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

basicAck()

public basicAck(int $delivery_tag[, bool $multiple = false ]) : array<string|int, mixed>
Parameters
$delivery_tag : int
$multiple : bool = false
Return values
array<string|int, mixed> —

basicCancel()

public basicCancel(string $consumer_tag[, bool $nowait = false ]) : array<string|int, mixed>
Parameters
$consumer_tag : string
$nowait : bool = false
Return values
array<string|int, mixed> —

basicCancelOk()

public static basicCancelOk(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

basicConsume()

public basicConsume(int $ticket[, string $queue = '' ][, string $consumer_tag = '' ][, bool $no_local = false ][, bool $no_ack = false ][, bool $exclusive = false ][, bool $nowait = false ][, AMQPTable|array<string|int, mixed> $arguments = array() ]) : array<string|int, mixed>
Parameters
$ticket : int
$queue : string = ''
$consumer_tag : string = ''
$no_local : bool = false
$no_ack : bool = false
$exclusive : bool = false
$nowait : bool = false
$arguments : AMQPTable|array<string|int, mixed> = array()
Return values
array<string|int, mixed> —

basicConsumeOk()

public static basicConsumeOk(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

basicDeliver()

public basicDeliver(string $consumer_tag, int $delivery_tag, bool $redelivered, string $exchange, string $routing_key) : array<string|int, mixed>
Parameters
$consumer_tag : string
$delivery_tag : int
$redelivered : bool
$exchange : string
$routing_key : string
Return values
array<string|int, mixed> —

basicGet()

public basicGet(int $ticket[, string $queue = '' ][, bool $no_ack = false ]) : array<string|int, mixed>
Parameters
$ticket : int
$queue : string = ''
$no_ack : bool = false
Return values
array<string|int, mixed> —

basicGetEmpty()

public static basicGetEmpty(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

basicGetOk()

public static basicGetOk(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

basicNack()

public basicNack(int $delivery_tag[, bool $multiple = false ][, bool $requeue = true ]) : array<string|int, mixed>
Parameters
$delivery_tag : int
$multiple : bool = false
$requeue : bool = true
Return values
array<string|int, mixed> —

basicPublish()

public basicPublish(int $ticket[, string $exchange = '' ][, string $routing_key = '' ][, bool $mandatory = false ][, bool $immediate = false ]) : array<string|int, mixed>
Parameters
$ticket : int
$exchange : string = ''
$routing_key : string = ''
$mandatory : bool = false
$immediate : bool = false
Return values
array<string|int, mixed> —

basicQos()

Specifies QoS

public basicQos(int $prefetch_size, int $prefetch_count[, bool $global = false ]) : array<string|int, mixed>

See https://www.rabbitmq.com/consumer-prefetch.html#overview for details

Parameters
$prefetch_size : int

Default is 0 (Alias for unlimited)

$prefetch_count : int

Default is 0 (Alias for unlimited)

$global : bool = false

Default is false, prefetch size and count are applied to each channel consumer separately

Return values
array<string|int, mixed> —

basicQosOk()

public static basicQosOk(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

basicRecover()

public basicRecover([bool $requeue = false ]) : array<string|int, mixed>
Parameters
$requeue : bool = false
Return values
array<string|int, mixed> —

basicRecoverAsync()

public basicRecoverAsync([bool $requeue = false ]) : array<string|int, mixed>
Parameters
$requeue : bool = false
Return values
array<string|int, mixed> —

basicRecoverOk()

public static basicRecoverOk(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

basicReject()

public basicReject(int $delivery_tag[, bool $requeue = true ]) : array<string|int, mixed>
Parameters
$delivery_tag : int
$requeue : bool = true
Return values
array<string|int, mixed> —

basicReturn()

public basicReturn(int $reply_code, string $reply_text, string $exchange, string $routing_key) : array<string|int, mixed>
Parameters
$reply_code : int
$reply_text : string
$exchange : string
$routing_key : string
Return values
array<string|int, mixed> —

channelClose()

public channelClose(int $reply_code, string $reply_text, int $class_id, int $method_id) : array<string|int, mixed>
Parameters
$reply_code : int
$reply_text : string
$class_id : int
$method_id : int
Return values
array<string|int, mixed> —

channelCloseOk()

public static channelCloseOk(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

channelFlow()

public channelFlow(bool $active) : array<string|int, mixed>
Parameters
$active : bool
Return values
array<string|int, mixed> —

channelFlowOk()

public static channelFlowOk(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

channelOpen()

public channelOpen([string $out_of_band = '' ]) : array<string|int, mixed>
Parameters
$out_of_band : string = ''
Return values
array<string|int, mixed> —

channelOpenOk()

public static channelOpenOk(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

confirmSelect()

public confirmSelect([bool $nowait = false ]) : array<string|int, mixed>
Parameters
$nowait : bool = false
Return values
array<string|int, mixed> —

confirmSelectOk()

public static confirmSelectOk(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

connectionBlocked()

public connectionBlocked([string $reason = '' ]) : array<string|int, mixed>
Parameters
$reason : string = ''
Return values
array<string|int, mixed> —

connectionClose()

public connectionClose(int $reply_code, string $reply_text, int $class_id, int $method_id) : array<string|int, mixed>
Parameters
$reply_code : int
$reply_text : string
$class_id : int
$method_id : int
Return values
array<string|int, mixed> —

connectionCloseOk()

public static connectionCloseOk(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

connectionOpen()

public connectionOpen([string $virtual_host = '/' ][, string $capabilities = '' ][, bool $insist = false ]) : array<string|int, mixed>
Parameters
$virtual_host : string = '/'
$capabilities : string = ''
$insist : bool = false
Return values
array<string|int, mixed> —

connectionOpenOk()

public static connectionOpenOk(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

connectionSecure()

public connectionSecure(string $challenge) : array<string|int, mixed>
Parameters
$challenge : string
Return values
array<string|int, mixed> —

connectionSecureOk()

public static connectionSecureOk(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

connectionStart()

public connectionStart(int $version_major[, int $version_minor = 9 ][, mixed $server_properties = [] ][, string $mechanisms = 'PLAIN' ][, string $locales = 'en_US' ]) : array<string|int, mixed>
Parameters
$version_major : int
$version_minor : int = 9
$server_properties : mixed = []
$mechanisms : string = 'PLAIN'
$locales : string = 'en_US'
Return values
array<string|int, mixed> —

connectionStartOk()

public static connectionStartOk(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

connectionTune()

public connectionTune(int $channel_max, int $frame_max, int $heartbeat) : array<string|int, mixed>
Parameters
$channel_max : int
$frame_max : int
$heartbeat : int
Return values
array<string|int, mixed> —

connectionTuneOk()

public static connectionTuneOk(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

connectionUnblocked()

public static connectionUnblocked(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

exchangeBind()

public exchangeBind(int $ticket[, string $destination = '' ][, string $source = '' ][, string $routing_key = '' ][, bool $nowait = false ][, AMQPTable|array<string|int, mixed> $arguments = array() ]) : array<string|int, mixed>
Parameters
$ticket : int
$destination : string = ''
$source : string = ''
$routing_key : string = ''
$nowait : bool = false
$arguments : AMQPTable|array<string|int, mixed> = array()
Return values
array<string|int, mixed> —

exchangeBindOk()

public static exchangeBindOk(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

exchangeDeclare()

public exchangeDeclare(int $ticket[, string $exchange = '' ][, string $type = 'direct' ][, bool $passive = false ][, bool $durable = false ][, bool $auto_delete = false ][, bool $internal = false ][, bool $nowait = false ][, AMQPTable|array<string|int, mixed> $arguments = array() ]) : array<string|int, mixed>
Parameters
$ticket : int
$exchange : string = ''
$type : string = 'direct'
$passive : bool = false
$durable : bool = false
$auto_delete : bool = false
$internal : bool = false
$nowait : bool = false
$arguments : AMQPTable|array<string|int, mixed> = array()
Return values
array<string|int, mixed> —

exchangeDeclareOk()

public static exchangeDeclareOk(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

exchangeDelete()

public exchangeDelete(int $ticket[, string $exchange = '' ][, bool $if_unused = false ][, bool $nowait = false ]) : array<string|int, mixed>
Parameters
$ticket : int
$exchange : string = ''
$if_unused : bool = false
$nowait : bool = false
Return values
array<string|int, mixed> —

exchangeDeleteOk()

public static exchangeDeleteOk(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

exchangeUnbind()

public exchangeUnbind(int $ticket[, string $destination = '' ][, string $source = '' ][, string $routing_key = '' ][, bool $nowait = false ][, AMQPTable|array<string|int, mixed> $arguments = array() ]) : array<string|int, mixed>
Parameters
$ticket : int
$destination : string = ''
$source : string = ''
$routing_key : string = ''
$nowait : bool = false
$arguments : AMQPTable|array<string|int, mixed> = array()
Return values
array<string|int, mixed> —

exchangeUnbindOk()

public static exchangeUnbindOk(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

queueBind()

public queueBind(int $ticket[, string $queue = '' ][, string $exchange = '' ][, string $routing_key = '' ][, bool $nowait = false ][, AMQPTable|array<string|int, mixed> $arguments = array() ]) : array<string|int, mixed>
Parameters
$ticket : int
$queue : string = ''
$exchange : string = ''
$routing_key : string = ''
$nowait : bool = false
$arguments : AMQPTable|array<string|int, mixed> = array()
Return values
array<string|int, mixed> —

queueBindOk()

public static queueBindOk(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

queueDeclare()

public queueDeclare(int $ticket[, string $queue = '' ][, bool $passive = false ][, bool $durable = false ][, bool $exclusive = false ][, bool $auto_delete = false ][, bool $nowait = false ][, AMQPTable|array<string|int, mixed> $arguments = array() ]) : array<string|int, mixed>
Parameters
$ticket : int
$queue : string = ''
$passive : bool = false
$durable : bool = false
$exclusive : bool = false
$auto_delete : bool = false
$nowait : bool = false
$arguments : AMQPTable|array<string|int, mixed> = array()
Return values
array<string|int, mixed> —

queueDeclareOk()

public static queueDeclareOk(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

queueDelete()

public queueDelete(int $ticket[, string $queue = '' ][, bool $if_unused = false ][, bool $if_empty = false ][, bool $nowait = false ]) : array<string|int, mixed>
Parameters
$ticket : int
$queue : string = ''
$if_unused : bool = false
$if_empty : bool = false
$nowait : bool = false
Return values
array<string|int, mixed> —

queueDeleteOk()

public static queueDeleteOk(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

queuePurge()

public queuePurge(int $ticket[, string $queue = '' ][, bool $nowait = false ]) : array<string|int, mixed>
Parameters
$ticket : int
$queue : string = ''
$nowait : bool = false
Return values
array<string|int, mixed> —

queuePurgeOk()

public static queuePurgeOk(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

queueUnbind()

public queueUnbind(int $ticket[, string $queue = '' ][, string $exchange = '' ][, string $routing_key = '' ][, AMQPTable|array<string|int, mixed> $arguments = array() ]) : array<string|int, mixed>
Parameters
$ticket : int
$queue : string = ''
$exchange : string = ''
$routing_key : string = ''
$arguments : AMQPTable|array<string|int, mixed> = array()
Return values
array<string|int, mixed> —

queueUnbindOk()

public static queueUnbindOk(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

txCommit()

public txCommit() : array<string|int, mixed>
Return values
array<string|int, mixed> —

txCommitOk()

public static txCommitOk(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

txRollback()

public txRollback() : array<string|int, mixed>
Return values
array<string|int, mixed> —

txRollbackOk()

public static txRollbackOk(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

txSelect()

public txSelect() : array<string|int, mixed>
Return values
array<string|int, mixed> —

txSelectOk()

public static txSelectOk(AMQPReader $reader) : array<string|int, mixed>
Parameters
$reader : AMQPReader
Return values
array<string|int, mixed> —

Search results