JavaSteam/in.dragonbra.javasteam.steam.steamclient.callbackmgr/CallbackManager

CallbackManager

class CallbackManager(steamClient: SteamClient)

This class is a utility for routing callbacks to function calls. In order to bind callbacks to functions, an instance of this class must be created for the SteamClient instance that will be posting callbacks.

Parameters

steamClient

The SteamClient instance to handle the callbacks of.

Constructors

CallbackManager

constructor(steamClient: SteamClient)

Initializes a new instance of the CallbackManager class.

Functions

runCallbacks

fun runCallbacks(): Boolean

Runs a single queued callback. If no callback is queued, this method will instantly return.

runWaitAllCallbacks

fun runWaitAllCallbacks(timeout: Long)

Blocks the current thread to run all queued callbacks. If no callback is queued, the method will block for the given timeout or until a callback becomes available. This method returns once the queue has been emptied.

runWaitCallbackAsync

suspend fun runWaitCallbackAsync()

runWaitCallbacks

fun runWaitCallbacks()

Blocks the current thread to run a single queued callback. If no callback is queued, the method will block until one becomes available.

fun runWaitCallbacks(timeout: Long): Boolean

Blocks the current thread to run a single queued callback. If no callback is queued, the method will block for the given timeout or until a callback becomes available.

inline fun <TCallback : CallbackMsg> subscribe(callbackFunc: Consumer<TCallback>): Closeable

inline fun <TCallback : CallbackMsg> subscribe(jobID: JobID = JobID.INVALID, noinline callbackFunc: (TCallback) -> Unit): Closeable

fun <TCallback : CallbackMsg> subscribe(callbackType: Class<out TCallback>, callbackFunc: Consumer<TCallback>): Closeable

fun <TCallback : CallbackMsg> subscribe(callbackType: Class<out TCallback>, jobID: JobID, callbackFunc: Consumer<TCallback>): Closeable

Registers the provided Consumer to receive callbacks of type TCallback

subscribeServiceNotification

inline fun <TService : UnifiedService, TNotification : GeneratedMessage.Builder<TNotification>> subscribeServiceNotification(noinline callback: (ServiceMethodNotification<TNotification>) -> Unit): Closeable

fun <TService : UnifiedService, TNotification : GeneratedMessage.Builder<TNotification>> subscribeServiceNotification(serviceClass: Class<TService>, notificationClass: Class<TNotification>, callbackFunc: Consumer<ServiceMethodNotification<TNotification>>): Closeable

Registers a callback to receive service notifications from Steam's unified messaging system.

subscribeServiceResponse

inline fun <TService : UnifiedService, TNotification : GeneratedMessage.Builder<TNotification>> subscribeServiceResponse(noinline callback: (ServiceMethodResponse<TNotification>) -> Unit): Closeable

fun <TService : UnifiedService, TNotification : GeneratedMessage.Builder<TNotification>> subscribeServiceResponse(serviceClass: Class<TService>, notificationClass: Class<TNotification>, callbackFunc: Consumer<ServiceMethodResponse<TNotification>>): Closeable

Registers a callback to receive service responses from Steam's unified messaging system.