Destination

Represents a STOMP destination.

Depending on the implementation, the message delivery is different. Queue are sending message to only one subscribers, while topics are broadcasting the message to all subscribers.

Implementations must be thread-safe.

package

Default

Methods

__construct

__construct() 

Handles a <code>ACK</code> frame.

ack( $arg0,  $arg1) : boolean

Arguments

$arg0

StompServerConnection

$arg1

Frame | array

Response

boolean

{@code true} if the destination has handled the frame (meaning it has sent the message with id)

bridge

bridge( $arg0,  $arg1) : \io\vertx\jphp\ext\stomp\Destination
static

Arguments

$arg0

Vertx

$arg1

array | BridgeOptions

Response

\io\vertx\jphp\ext\stomp\Destination

destination

destination() : string

Response

string

the destination address.

Dispatches the given frame.

dispatch( $arg0,  $arg1) : $this

Arguments

$arg0

StompServerConnection

$arg1

Frame | array

Response

$this

the current instance of {@link Destination}

Gets all subscription ids for the given destination hold by the given client

getSubscriptions( $arg0) : array

Arguments

$arg0

StompServerConnection

Response

array

the list of subscription id, empty if none

Checks whether or not the given address matches with the current destination.

matches( $arg0) : boolean

Arguments

$arg0

string

Response

boolean

{@code true} if it matches, {@code false} otherwise.

Handles a <code>NACK</code> frame.

nack( $arg0,  $arg1) : boolean

Arguments

$arg0

StompServerConnection

$arg1

Frame | array

Response

boolean

{@code true} if the destination has handled the frame (meaning it has sent the message with id)

Gets the number of subscriptions attached to the current @see \io\vertx\jphp\ext\stomp\Destination.

numberOfSubscriptions() : integer

Response

integer

the number of subscriptions.

queue

queue( $arg0,  $arg1) : \io\vertx\jphp\ext\stomp\Destination
static

Arguments

$arg0

Vertx

$arg1

string

Response

\io\vertx\jphp\ext\stomp\Destination

Handles a subscription request to the current @see \io\vertx\jphp\ext\stomp\Destination.

subscribe( $arg0,  $arg1) : $this

Arguments

$arg0

StompServerConnection

$arg1

Frame | array

Response

$this

the current instance of {@link Destination}

topic

topic( $arg0,  $arg1) : \io\vertx\jphp\ext\stomp\Destination
static

Arguments

$arg0

Vertx

$arg1

string

Response

\io\vertx\jphp\ext\stomp\Destination

Handles a un-subscription request to the current @see \io\vertx\jphp\ext\stomp\Destination.

unsubscribe( $arg0,  $arg1) : boolean

Arguments

$arg0

StompServerConnection

$arg1

Frame | array

Response

boolean

{@code true} if the un-subscription has been handled, {@code false} otherwise.

Removes all subscriptions of the given connection

unsubscribeConnection( $arg0) : $this

Arguments

$arg0

StompServerConnection

Response

$this

the current instance of {@link Destination}