@wuespace/vertx-mock-server

class MockServer

A mock server for a Vert.x WebSocket Event Bus bridge to JavaScript clients like @wuespace/vertx-event-bus#EventBus.

Constructors

function (
   options ? : Partial<VertxMockServerOptions>
) : any

Builds a new Vert.x mock server.

const logger = new Logger({
	loggers: [ChalkLogger(chalk)]
});

const moduleLogger = logger.getComponentLogger('MockServer');

const server = new MockServer({ logger: moduleLogger });
server.listen();

Properties

Methods

function listen (
   options ? : Partial<ListenOptions>
) : void

Starts the Vert.x mock server, listening for incoming connections.

const server = new MockServer();
server.listen({
	port: 12345,
	hostname: 'localhost'
}); // listen on port 12345 on 'localhost'

function close ( ) : Promise<void>

Stops the server from accepting new connections and closes currently active connections.

const server = new MockServer();
server.listen();
// some code later
server.close().then(() => console.log('Closed'));

function send (
   channel : ChannelAddress ,
   content : JsonSerializable
) : void

Sends a message to the specified channel.

const CHANNEL = 'my-channel';

class MyMockServer extends MockServer implements OnInit, OnClose {
	private iteration: number = 0;
	private intervalId: any = undefined;

	onInit() {
		// send and increment
		this.intervalId = setInterval(() => {
			this.send(CHANNEL, this.iteration);
		  this.iteration = this.iteration + 1;
		}, 1000);
	}

	onClose() {
		if (this.intervalId) {
			clearInterval(this.intervalId);
			this.intervalId = undefined;
		}
	}
}

const server = new MyMockServer();
server.listen();

function sendError (
   error : ErrorContent
) : void

Sends an error message to the specified channel.

const CHANNEL = 'my-channel';

class MyMockServer extends MockServer implements OnInit, OnClose {
	private id: CallbackId = 0;

	onInit() {
		this.id = this.register(CHANNEL, () => {
			this.sendError({
				failureCode: 1,
				failureType: 'Message received',
				message: 'Message was received'
			});
		});
	}

	onClose() {
		this.unregister(this.id);
	}
}

const server = new MyMockServer();
server.listen();

function register (
   channel : ChannelAddress ,
   callback : Callback
) : CallbackId

Registers a callback to a specified channel. The callback gets called when a new message arrives on this channel.

const CHANNEL = 'my-channel';

class MyMockServer extends MockServer implements OnInit, OnClose {
	private id: CallbackId = 0;

	onInit() {
		this.id = this.register(CHANNEL, () => {
			this.send(CHANNEL, 'pong');
		});
	}

	onClose() {
		this.unregister(this.id);
	}
}

const server = new MyMockServer();
server.listen();

function unregister (
   id : CallbackId
) : void

Unregisters/Removes a callback from a channel with the given callback id from the MockServer.register function.

const CHANNEL = 'my-channel';

class MyMockServer extends MockServer implements OnInit, OnClose {
	private id: CallbackId = 0;

	onInit() {
		this.id = this.register(CHANNEL, () => {
			this.send(CHANNEL, 'pong');
		});
	}

	onClose() {
		this.unregister(this.id);
	}
}

const server = new MyMockServer();
server.listen();

function getConnections ( ) : Array<Connection>

Get all currently active SockJS connections to the Vert.x mock server.

const CHANNEL = 'my-channel';

class MyMockServer extends MockServer implements OnInit, OnClose {
	private id: CallbackId = 0;

	onInit() {
		this.id = this.register(CHANNEL, args => {
			if (args.type === 'send') args.respond(this.getConnections().length);
		});
	}

	onClose() {
		this.unregister(this.id);
	}
}

const server = new MyMockServer();
server.listen();

type ErrorContent

Alias for: Pick< ErrorMessage, 'failureCode' | 'failureType' | 'message' >

The contents of an error message.

interface OnInit

Defines an event handler that gets called when the Vert.x mock server is set up and ready to handle incoming connections.

Properties

Methods

function onInit ( ) : void

An event handler which gets called when a the Vert.x mock server is set up and ready to handle incoming connections.

interface OnConnection

Defines an event handler that gets called when a new connection with a client is established and all MockServer.register calls have taken place.

Properties

Methods

function onConnection (
   connection : Connection
) : void

An event handler which gets called when a new connection with a client is established and all MockServer.register calls have taken place.

interface OnMessage

Defines an event handler that gets called when a messages arrives at the Vert.x mock server from any connected client.

Properties

Methods

function onMessage (
   message : Message
) : boolean | void

An event handler which gets called when a new message arrives at the event bus.

interface OnClosedConnection

Defines an event handler that gets called when a connection to a client has closed.

Properties

Methods

function onClosedConnection (
   connection : Connection
) : void

An event handler which gets called when a connection to a client has closed.

interface OnClose

Defines an event handler that gets called when the Vert.x mock server closed all still active connections and will shutdown now.

Properties

Methods

function onClose ( ) : void

An event handler which gets called when the Vert.x mock server closed all still active connections and will shutdown now.

interface SendCallbackArgs extends BaseCallbackArgs

The arguments of a send callback which gets called when the Vert.x mock server receives a @wuespace/telestion-client-types#SendMessage.

Properties

Type: 'send'

No docs provided

Type: (response: JsonSerializable) => void

A callback to respond to the sent message.

interface PublishCallbackArgs extends BaseCallbackArgs

The arguments of a publish callback which gets called when the Vert.x mock server receives a @wuespace/telestion-client-types#PublishMessage.

Properties

Type: 'publish'

No docs provided

type CallbackArgs

Alias for: SendCallbackArgs | PublishCallbackArgs

The arguments of a callback which gets called when the Vert.x mock server receives a @wuespace/telestion-client-types#SendMessage or a @wuespace/telestion-client-types#PublishMessage from a client.

type Callback

Alias for: (args: CallbackArgs) => void

The callback which gets called when the Vert.x mock server receives a @wuespace/telestion-client-types#SendMessage or a @wuespace/telestion-client-types#PublishMessage from a client.

type CallbackId

Alias for: number

The id of a registered callback.

It can be registered with MockServer.register and unregistered with this value in MockServer.unregister.

interface ListenOptions

Options to configure the Vert.x mock server in the listen process.

Properties

Type: number

The port on which the server listens.

Defaults to 9870.

Type: string

The hostname on which the server listens.

Defaults to '0.0.0.0'.

interface VertxMockServerOptions

Options to configure the Vert.x mock server on creation.

Properties

Type: string

The prefix on which the event bus will be available.

Defaults tp '/bridge'.

Type: ComponentLogger

The logging instance the mock server uses to print out connection and debug information.

Notice: By default, the mock server does not print anything to console.