com.wedeploy.api.sdk.realtime

Interface SocketEventEmitter

All Known Subinterfaces:

Socket, SocketNamespace

public interface SocketEventEmitter

SocketIO emitter.

Method Summary

Modifier and Type	Method and Description
SocketEventEmitter	emit(java.lang.String event, java.lang.Object... args) Emits `event` with the given args.
boolean	hasListeners(java.lang.String event) Checks if this emitter has `event` handlers.
java.util.List<SocketListener>	listeners(java.lang.String event) Returns an array of listeners for `event`.
SocketEventEmitter	off() Remove all registered listeners.
SocketEventEmitter	off(java.lang.String event) Remove the given callback for `event`.
SocketEventEmitter	off(java.lang.String event, SocketListener fn) Remove the given callback for `event`.
SocketEventEmitter	on(java.lang.String event, SocketListener fn) Listen on the given `event` with listener `fn`.
SocketEventEmitter	once(java.lang.String event, SocketListener fn) Adds an `event` listener that will be invoked a single time then automatically removed.

Method Detail

emit

SocketEventEmitter emit(java.lang.String event,
                        java.lang.Object... args)

Emits `event` with the given args.

hasListeners

boolean hasListeners(java.lang.String event)

Checks if this emitter has `event` handlers.

listeners

java.util.List<SocketListener> listeners(java.lang.String event)

Returns an array of listeners for `event`.

off

SocketEventEmitter off()

Remove all registered listeners.

off

SocketEventEmitter off(java.lang.String event)

Remove the given callback for `event`.

off

SocketEventEmitter off(java.lang.String event,
                       SocketListener fn)

Remove the given callback for `event`.

on

SocketEventEmitter on(java.lang.String event,
                      SocketListener fn)

Listen on the given `event` with listener `fn`.

once

SocketEventEmitter once(java.lang.String event,
                        SocketListener fn)

Adds an `event` listener that will be invoked a single time then automatically removed.