- Description
this is a Stomp client.
-
Inherit protocol
.protocol
-
Method create
void Public.Protocols.Stomp.Client()->create()
-
Method set_auth
void Public.Protocols.Stomp.Client()->set_auth(string u, string p)
-
Method get_session
string Public.Protocols.Stomp.Client()->get_session()
-
Method connect
void Public.Protocols.Stomp.Client()->connect(string host, int port)
-
Method begin
string Public.Protocols.Stomp.Client()->begin(int(0..1)|void receipt)
- Description
begin a transaction.
- Returns
the transaction identifier string
-
Method commit
int Public.Protocols.Stomp.Client()->commit(string txid, int(0..1)|void receipt)
- Description
commit a transaction
- Parameter txid
the transaction identifier of the transaction to commit.
- Parameter receipt
should we await confirmation of this command from the server?
-
Method abort
int Public.Protocols.Stomp.Client()->abort(string txid, int(0..1)|void receipt)
- Description
abort a transaction, rolling back any messages
- Parameter txid
the transaction identifier of the transaction to abort.
- Parameter receipt
should we await confirmation of this command from the server?
-
Method subscribe
int Public.Protocols.Stomp.Client()->subscribe(string destination, function callback, int(0..1)|void acknowledge, int(0..1)|void receipt)
- Description
subscribe to a topic or queue
- Parameter callback
a function that takes receives a Frame object for each message
delivered and returns one to acknowledge or zero to refuse receipt
of the message
- Parameter acknowledge
should we require recieved messages to be acknowledged?
- Parameter receipt
should we await confirmation of this command from the server?
-
Method unsubscribe
int Public.Protocols.Stomp.Client()->unsubscribe(string destination, int(0..1)|void receipt)
- Description
unsubscribe from a topic or queue.
- Parameter destination
the queue or topic we wish to unsubscribe from.
- Parameter receipt
should we await confirmation of this command from the server?
-
Method send
int Public.Protocols.Stomp.Client()->send(string destination, string message, mapping|void headers, string|void txid, int(0..1)|void receipt)
- Description
send a message to a queue or topic
- Parameter destination
the name of the topic or queue to send the message to.
- Parameter message
the contents of the message to be sent
- Parameter headers
a list of headers we wish to include in the message
- Parameter txid
transaction identifier of the transaction we wish to associate
this message with.
- Parameter receipt
should we await confirmation of this command from the server?
|
modules.gotpike.org