Constructor

Constructor([url[, options]])

Wampy constructor can take 2 parameters:

• url to wamp server - optional. URL can be specified in next forms:

  • Undefined/null. In browser environment page-scheme://page-server:page-port/ws will be used in this case.

  • String, begins with '/', meaning some path on current scheme://host:port.

  • Full qualified URL, starting with scheme 'ws' or 'wss'.

  • Host/domain with possible path, but without scheme. In browser environment page-scheme will be used.

• options hash-table. The only required field is realm. For node.js environment also necessary to specify ws - websocket module. See description below.

// in browser
wampy = new Wampy();
wampy = new Wampy('/my-socket-path');
wampy = new Wampy('wss://socket.server.com:5000/ws', { autoReconnect: false });
wampy = new Wampy({ reconnectInterval: 1*1000 });

// in node.js
w3cws = require('websocket').w3cwebsocket;
wampy = new Wampy(null, { ws: w3cws });
wampy = new Wampy('/my-socket-path', { ws: w3cws });
wampy = new Wampy('wss://socket.server.com:5000/ws', { autoReconnect: false, ws: w3cws });
wampy = new Wampy({ reconnectInterval: 1*1000, ws: w3cws });

// or using ws example
import WebSocket from 'ws';
wampy = new Wampy(null, { ws: WebSocket });
wampy = new Wampy('/my-socket-path', { ws: WebSocket });
wampy = new Wampy('wss://socket.server.com:5000/ws', { autoReconnect: false, ws: WebSocket });
wampy = new Wampy({ reconnectInterval: 1*1000, ws: WebSocket });

Json serializer will be used by default. If you want to use msgpack or cbor serializer, pass it through options. Also, you can use your own serializer. Just be sure, it is supported on WAMP router side!

// in browser
wampy = new Wampy('wss://socket.server.com:5000/ws', {
    serializer: new MsgpackSerializer()
});
wampy = new Wampy({
    serializer: new CborSerializer()
});

// in node.js
import {Wampy} from 'wampy';
import {MsgpackSerializer} from 'wampy/MsgpackSerializer';
import {CborSerializer} from 'wampy/CborSerializer';
import WebSocket from 'ws';

wampy = new Wampy('wss://socket.server.com:5000/ws', {
    ws: WebSocket,
    serializer: new MsgpackSerializer()
});
wampy = new Wampy({
    ws: w3cws,
    serializer: new CborSerializer()
});