com.enjin.sdk.events

Class PusherEventService

java.lang.Object

com.enjin.sdk.events.PusherEventService

All Implemented Interfaces:

IEventService

public class PusherEventService
extends java.lang.Object
implements IEventService

Implementation class of IEventService utilizing Pusher channel events.

See Also:

IEventListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PusherEventService.PusherEventServiceBuilder Builder class for PusherEventService.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<EventListenerRegistration>	listeners The list of listener registrations.

Method Summary

Modifier and Type	Method and Description
static PusherEventService.PusherEventServiceBuilder	builder() Creates a builder for this class.
protected EventListenerRegistration.RegistrationListenerConfiguration	configureListener(@NonNull IEventListener listener) Configures a notification listener.
LoggerProvider	getLoggerProvider()
boolean	isConnected() Checks if this service is connected to the platform.
boolean	isSubscribedToAsset(java.lang.String asset) Determines if the channel is open for the specified asset.
boolean	isSubscribedToPlayer(java.lang.String project, java.lang.String player) Determines if the channel is open for the specified player.
boolean	isSubscribedToProject(java.lang.String project) Determines if the channel is open for the specified project.
boolean	isSubscribedToWallet(java.lang.String wallet) Determines if the channel is open for the specified wallet address.
protected EventListenerRegistration	register(@NonNull EventListenerRegistration.RegistrationListenerConfiguration configuration) Registers a notification listener.
EventListenerRegistration	registerListener(@NonNull IEventListener listener) Registers a event listener and provides the registration object used for it.
EventListenerRegistration	registerListenerExcludingTypes(@NonNull IEventListener listener, EventType... types) Registers a event listener with event types to ignore and provides the registration object used for it.
EventListenerRegistration	registerListenerIncludingTypes(@NonNull IEventListener listener, EventType... types) Registers a event listener with event types to allow and provides the registration object used for it.
EventListenerRegistration	registerListenerWithMatcher(@NonNull IEventListener listener, IEventMatcher matcher) Registers a event listener with an event matcher and provides the registration object used for it.
java.util.concurrent.Future<java.lang.Void>	shutdown() Shuts down this service.
java.util.concurrent.Future<java.lang.Void>	start() Starts this service.
java.util.concurrent.Future<java.lang.Void>	start(IConnectionEventListener listener) Starts this service with the provided connection listener.
java.util.concurrent.Future<java.lang.Void>	start(Platform platform) Starts this service with the provided platform details.
java.util.concurrent.Future<java.lang.Void>	start(Platform platform, IConnectionEventListener listener) Starts this service with the provided platform details and connection listener.
void	subscribeToAsset(java.lang.String asset) Opens a channel for the specified asset, allowing listeners to receive events for that asset.
void	subscribeToPlayer(java.lang.String project, java.lang.String player) Opens a channel for the specified player, allowing listeners to receive events for that player.
void	subscribeToProject(java.lang.String project) Opens a channel for the specified project, allowing listeners to receive events for that project.
void	subscribeToWallet(java.lang.String wallet) Opens a channel for the specified wallet address, allowing listeners to receive events for that wallet.
void	unregisterListener(@NonNull IEventListener listener) Unregisters a event listener.
void	unsubscribeToAsset(java.lang.String asset) Closes a channel for the specified asset, preventing listeners from receiving events for that asset.
void	unsubscribeToPlayer(java.lang.String project, java.lang.String player) Closes a channel for the specified player, preventing listeners from receiving events for that player.
void	unsubscribeToProject(java.lang.String project) Closes a channel for the specified project, preventing listeners from receiving events for that project.
void	unsubscribeToWallet(java.lang.String wallet) Closes a channel for the specified wallet address, preventing listeners from receiving events for that wallet.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

listeners

protected java.util.List<EventListenerRegistration> listeners

The list of listener registrations.

Method Detail

start

public java.util.concurrent.Future<java.lang.Void> start()

Description copied from interface: IEventService

Starts this service.

Specified by:

start in interface IEventService

Returns:

the future for this operation

start

public java.util.concurrent.Future<java.lang.Void> start(Platform platform)

Description copied from interface: IEventService

Starts this service with the provided platform details.

Specified by:

start in interface IEventService

Parameters:

platform - the platform

Returns:

the future for this operation

start

public java.util.concurrent.Future<java.lang.Void> start(IConnectionEventListener listener)

Description copied from interface: IEventService

Starts this service with the provided connection listener.

Specified by:

start in interface IEventService

Parameters:

listener - the listener

Returns:

the future for this operation

start

public java.util.concurrent.Future<java.lang.Void> start(Platform platform,
                                                         IConnectionEventListener listener)

Description copied from interface: IEventService

Starts this service with the provided platform details and connection listener.

Specified by:

start in interface IEventService

Parameters:

platform - the platform

listener - the listener

Returns:

the future for this operation

isConnected

public boolean isConnected()

Description copied from interface: IEventService

Checks if this service is connected to the platform.

Specified by:

isConnected in interface IEventService

Returns:

true if connected, else false

shutdown

public java.util.concurrent.Future<java.lang.Void> shutdown()

Description copied from interface: IEventService

Shuts down this service.

Specified by:

shutdown in interface IEventService

Returns:

the future for this operation

registerListener

public EventListenerRegistration registerListener(@NonNull
                                                  @NonNull IEventListener listener)

Description copied from interface: IEventService

Registers a event listener and provides the registration object used for it.

Specified by:

registerListener in interface IEventService

Parameters:

listener - the listener

Returns:

the registration

registerListenerWithMatcher

public EventListenerRegistration registerListenerWithMatcher(@NonNull
                                                             @NonNull IEventListener listener,
                                                             IEventMatcher matcher)

Description copied from interface: IEventService

Registers a event listener with an event matcher and provides the registration object used for it.

Specified by:

registerListenerWithMatcher in interface IEventService

Parameters:

listener - the listener

matcher - the event matcher

Returns:

the registration

registerListenerIncludingTypes

public EventListenerRegistration registerListenerIncludingTypes(@NonNull
                                                                @NonNull IEventListener listener,
                                                                EventType... types)

Description copied from interface: IEventService

Registers a event listener with event types to allow and provides the registration object used for it.

Specified by:

registerListenerIncludingTypes in interface IEventService

Parameters:

listener - the listener

types - the events to listen for

Returns:

the registration

registerListenerExcludingTypes

public EventListenerRegistration registerListenerExcludingTypes(@NonNull
                                                                @NonNull IEventListener listener,
                                                                EventType... types)

Description copied from interface: IEventService

Registers a event listener with event types to ignore and provides the registration object used for it.

Specified by:

registerListenerExcludingTypes in interface IEventService

Parameters:

listener - the listener

types - the events to ignore

Returns:

the registration

configureListener

protected EventListenerRegistration.RegistrationListenerConfiguration configureListener(@NonNull
                                                                                        @NonNull IEventListener listener)

Configures a notification listener.

Parameters:

listener - the listener

Returns:

the listener configuration

register

protected EventListenerRegistration register(@NonNull
                                             @NonNull EventListenerRegistration.RegistrationListenerConfiguration configuration)

Registers a notification listener.

Parameters:

configuration - the listener configuration

Returns:

the registration wrapper, or null if registration failed

unregisterListener

public void unregisterListener(@NonNull
                               @NonNull IEventListener listener)

Description copied from interface: IEventService

Unregisters a event listener.

Specified by:

unregisterListener in interface IEventService

Parameters:

listener - the listener

subscribeToProject

public void subscribeToProject(java.lang.String project)

Description copied from interface: IEventService

Opens a channel for the specified project, allowing listeners to receive events for that project.

Specified by:

subscribeToProject in interface IEventService

Parameters:

project - the project's UUID

unsubscribeToProject

public void unsubscribeToProject(java.lang.String project)

Description copied from interface: IEventService

Closes a channel for the specified project, preventing listeners from receiving events for that project.

Specified by:

unsubscribeToProject in interface IEventService

Parameters:

project - the project's UUID

isSubscribedToProject

public boolean isSubscribedToProject(java.lang.String project)

Description copied from interface: IEventService

Determines if the channel is open for the specified project.

Specified by:

isSubscribedToProject in interface IEventService

Parameters:

project - the project's UUID

Returns:

true if open, else false

subscribeToPlayer

public void subscribeToPlayer(java.lang.String project,
                              java.lang.String player)

Description copied from interface: IEventService

Opens a channel for the specified player, allowing listeners to receive events for that player.

Specified by:

subscribeToPlayer in interface IEventService

Parameters:

project - the UUID of the project the player is on

player - the player ID

unsubscribeToPlayer

public void unsubscribeToPlayer(java.lang.String project,
                                java.lang.String player)

Description copied from interface: IEventService

Closes a channel for the specified player, preventing listeners from receiving events for that player.

Specified by:

unsubscribeToPlayer in interface IEventService

Parameters:

project - the UUID of the project the player is on

player - the player ID

isSubscribedToPlayer

public boolean isSubscribedToPlayer(java.lang.String project,
                                    java.lang.String player)

Description copied from interface: IEventService

Determines if the channel is open for the specified player.

Specified by:

isSubscribedToPlayer in interface IEventService

Parameters:

project - the UUID of the project the player is on

player - the player ID

Returns:

true if open, else false

subscribeToAsset

public void subscribeToAsset(java.lang.String asset)

Description copied from interface: IEventService

Opens a channel for the specified asset, allowing listeners to receive events for that asset.

Specified by:

subscribeToAsset in interface IEventService

Parameters:

asset - the asset ID

unsubscribeToAsset

public void unsubscribeToAsset(java.lang.String asset)

Description copied from interface: IEventService

Closes a channel for the specified asset, preventing listeners from receiving events for that asset.

Specified by:

unsubscribeToAsset in interface IEventService

Parameters:

asset - the asset ID

isSubscribedToAsset

public boolean isSubscribedToAsset(java.lang.String asset)

Description copied from interface: IEventService

Determines if the channel is open for the specified asset.

Specified by:

isSubscribedToAsset in interface IEventService

Parameters:

asset - the asset ID

Returns:

true if open, else false

subscribeToWallet

public void subscribeToWallet(java.lang.String wallet)

Description copied from interface: IEventService

Opens a channel for the specified wallet address, allowing listeners to receive events for that wallet.

Specified by:

subscribeToWallet in interface IEventService

Parameters:

wallet - the address

unsubscribeToWallet

public void unsubscribeToWallet(java.lang.String wallet)

Description copied from interface: IEventService

Closes a channel for the specified wallet address, preventing listeners from receiving events for that wallet.

Specified by:

unsubscribeToWallet in interface IEventService

Parameters:

wallet - the address

isSubscribedToWallet

public boolean isSubscribedToWallet(java.lang.String wallet)

Description copied from interface: IEventService

Determines if the channel is open for the specified wallet address.

Specified by:

isSubscribedToWallet in interface IEventService

Parameters:

wallet - the address

Returns:

true if open, else false

builder

public static PusherEventService.PusherEventServiceBuilder builder()

Creates a builder for this class.

Returns:

The builder.

getLoggerProvider

public LoggerProvider getLoggerProvider()

Returns:

the logger provider