Behind the scene, the client will open a connection using a WebSocket and send a CONNECT frame.
The connection is done asynchronously: you have no guarantee to be effectively connected when
- the call to connect returns. To be notified of the connection, you can pass a
+ the call to connect returns. To be notified of the connection, you need to pass a
connect_callback function to the connect() method:
- client.connect(login, passcode, connect_callback);
-
- connect_callback = function() {
+ var connect_callback = function() {
// called back after the client is connected and authenticated to the STOMP server
};
But what happens if the connection fails? the connect() method accepts an
optional error_callback argument which will be called if the client is not able
to connect to the server.
@@ -223,21 +220,43 @@
- client.connect(login, passcode, connect_callback, error_callback);
-
- error_callback = function(error) {
+ var error_callback = function(error) {
// display the error's message header:
alert(error.headers.message);
};
Finally, if the STOMP broker requires a host, pass it as the last argument of the connect() method:
+
The connect() method accepts different number of arguments to provide a simple API to use in most cases:
- var host = "...";
- client.connect(login, passcode, connect_callback, error_callback, host);
+ client.connect(login, passcode, connectCallback);
+ client.connect(login, passcode, connectCallback, errorCallback);
+ client.connect(login, passcode, connectCallback, errorCallback, host);
where login, passcode are strings and connectCallback and errorCallback are functions
+ (some brokers also require to pass a host String).
+
+
The connect() method also accepts two other variants if you need to pass additional headers:
+
+
+ client.connect(headers, connectCallback);
+ client.connect(headers, connectCallback, errorCallback);
+where header is a map and connectCallback and errorCallback are functions.
+
Please note that if you use these forms, you must add the login, passcode (and eventually host)
+ headers yourself:
+
+
+ var headers = {
+ login: 'mylogin',
+ passcode: 'mypasscode',
+ // additional header
+ 'client-id': 'my-client-id'
+ };
+ client.connect(headers, connectCallback);
+ To disconnect a client from the server, you can call its disconnect() method.
The disconnection is asynchronous: to be notified when the disconnection is effective,
diff --git a/src/stomp.coffee b/src/stomp.coffee
index 7f0bf41..bd23ae6 100644
--- a/src/stomp.coffee
+++ b/src/stomp.coffee
@@ -174,12 +174,40 @@ class Client
@ws.close()
, ttl)
+ # parse the arguments number and type to find the headers, connectCallback and
+ # (eventually undefined) errorCallback
+ _parseConnect: (args...) ->
+ headers = {}
+ switch args.length
+ when 2
+ [headers, connectCallback] = args
+ when 3
+ if args[1] instanceof Function
+ [headers, connectCallback, errorCallback] = args
+ else
+ [headers.login, headers.passcode, connectCallback] = args
+ when 4
+ [headers.login, headers.passcode, connectCallback, errorCallback] = args
+ else
+ [headers.login, headers.passcode, connectCallback, errorCallback, headers.vhost] = args
+
+ [headers, connectCallback, errorCallback]
+
# [CONNECT Frame](http://stomp.github.com/stomp-specification-1.1.html#CONNECT_or_STOMP_Frame)
- connect: (login,
- passcode,
- @connectCallback,
- errorCallback,
- vhost) ->
+ #
+ # The `connect` method accepts different number of arguments and types:
+ #
+ # * `connect(headers, connectCallback)`
+ # * `connect(headers, connectCallback, errorCallback)`
+ # * `connect(login, passcode, connectCallback)`
+ # * `connect(login, passcode, connectCallback, errorCallback)`
+ # * `connect(login, passcode, connectCallback, errorCallback, vhost)`
+ #
+ # The errorCallback is optional and the 2 first forms allow to pass other
+ # headers in addition to `client`, `passcode` and `vhost`.
+ connect: (args...) ->
+ out = @_parseConnect(args...)
+ [headers, @connectCallback, errorCallback] = out
@debug? "Opening Web Socket..."
@ws.onmessage = (evt) =>
data = if typeof(ArrayBuffer) != 'undefined' and evt.data instanceof ArrayBuffer
@@ -244,13 +272,8 @@ class Client
errorCallback?(msg)
@ws.onopen = =>
@debug?('Web Socket Opened...')
- headers = {
- "accept-version": Stomp.VERSIONS.supportedVersions()
- "heart-beat": [@heartbeat.outgoing, @heartbeat.incoming].join(',')
- }
- headers.host = vhost if vhost
- headers.login = login if login
- headers.passcode = passcode if passcode
+ headers["accept-version"] = Stomp.VERSIONS.supportedVersions()
+ headers["heart-beat"] = [@heartbeat.outgoing, @heartbeat.incoming].join(',')
@_transmit "CONNECT", headers
# [DISCONNECT Frame](http://stomp.github.com/stomp-specification-1.1.html#DISCONNECT)