1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
<?php
/**
* Get the current version of the stomp extension
*
* @return string version
*/
function stomp_version() {
}
/**
* Connect to server
*
* @param string $broker broker URI
* @param string $username The username
* @param string $password The password
* @param array $headers additional headers (example: receipt).
* @return Ressource stomp connection identifier on success, or FALSE on failure
*/
function stomp_connect($broker = null, $username = null, $password = null, array $headers = array()) {
}
/**
* Get the current stomp session ID
*
* @param ressource $link identifier returned by stomp_connect
* @return string stomp session ID if it exists, or FALSE otherwise
*/
function stomp_get_session_id($link) {
}
/**
* Close stomp connection
*
* @param ressource $link identifier returned by stomp_connect
* @return boolean TRUE on success, or FALSE on failure
*/
function stomp_close($link) {
}
/**
* Sends a message to a destination in the messaging system
*
* @param ressource $link identifier returned by stomp_connect
* @param string $destination indicates where to send the message
* @param string|StompFrame $msg message to be sent
* @param array $headers additional headers (example: receipt).
* @return boolean TRUE on success, or FALSE on failure
*/
function stomp_send($link, $destination, $msg, array $headers = array()) {
}
/**
* Register to listen to a given destination
*
* @param ressource $link identifier returned by stomp_connect
* @param string $destination indicates which destination to subscribe to
* @param array $headers additional headers (example: receipt).
* @return boolean TRUE on success, or FALSE on failure
*/
function stomp_subscribe($link, $destination, array $headers = array()) {
}
/**
* Remove an existing subscription
*
* @param ressource $link identifier returned by stomp_connect
* @param string $destination indicates which subscription to remove
* @param array $headers additional headers (example: receipt).
* @return boolean TRUE on success, or FALSE on failure
*/
function stomp_unsubscribe($link, $destination, array $headers = array()) {
}
/**
* Indicate whether or not there is a frame ready to read
*
* @param ressource $link identifier returned by stomp_connect
* @return boolean TRUE if there is one, or FALSE otherwise
*/
function stomp_has_frame($link) {
}
/**
* Read the next frame
*
* @param ressource $link identifier returned by stomp_connect
* @return array on success, or FALSE on failure
*/
function stomp_read_frame($link) {
}
/**
* Start a transaction
*
* @param ressource $link identifier returned by stomp_connect
* @param string $transaction_id transaction id
* @return boolean TRUE on success, or FALSE on failure
*/
function stomp_begin($link, $transaction_id) {
}
/**
* Commit a transaction in progress
*
* @param ressource $link identifier returned by stomp_connect
* @param string $transaction_id transaction id
* @return boolean TRUE on success, or FALSE on failure
*/
function stomp_commit($link, $transaction_id) {
}
/**
* Roll back a transaction in progress
*
* @param ressource $link identifier returned by stomp_connect
* @param string $transaction_id transaction id
* @return boolean TRUE on success, or FALSE on failure
*/
function stomp_abort($link, $transaction_id) {
}
/**
* Acknowledge consumption of a message from a subscription using client acknowledgment
*
* @param ressource $link identifier returned by stomp_connect
* @param string|StompFrame $msg message/messageId to be acknowledged
* @param array $headers additional headers (example: receipt).
* @return boolean TRUE on success, or FALSE on failure
*/
function stomp_ack($link, $msg, array $headers = array()) {
}
/**
* Get the last stomp error
*
* @param ressource $link identifier returned by stomp_connect
* @return string Error message, or FALSE if no error
*/
function stomp_error($link) {
}
/**
* Set timeout
*
* @param ressource $link identifier returned by stomp_connect
* @param int $seconds the seconds part of the timeout to be set
* @param int $microseconds the microseconds part of the timeout to be set
* @return void
*/
function stomp_set_timeout($link, $seconds, $microseconds = 0) {
}
/**
* Get timeout
*
* @param ressource $link identifier returned by stomp_connect
* @return array Array with timeout informations
*/
function stomp_get_timeout($link) {
}
|
