software.amazon.awssdk.crt.io

Class EventLoopGroup

java.lang.Object

software.amazon.awssdk.crt.CrtResource

software.amazon.awssdk.crt.io.EventLoopGroup

All Implemented Interfaces:

AutoCloseable

public final class EventLoopGroup
extends CrtResource

This class wraps the aws_event_loop_group from aws-c-io to provide access to an event loop for the MQTT protocol stack in the AWS Common Runtime.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.awssdk.crt.CrtResource

CrtResource.ResourceInstance

Constructor Summary

Constructors

Constructor and Description
EventLoopGroup(int numThreads) Creates a new event loop group for the I/O subsystem to use to run blocking I/O requests

Method Summary

Modifier and Type	Method and Description
protected boolean	canReleaseReferencesImmediately() Determines whether a resource releases its dependencies at the same time the native handle is released or if it waits.
CompletableFuture<Void>	getShutdownCompleteFuture()
protected void	releaseNativeHandle() Stops the event loop group's tasks and frees all resources associated with the the group.

Methods inherited from class software.amazon.awssdk.crt.CrtResource

acquireNativeHandle, addRef, addReferenceTo, close, collectNativeResource, collectNativeResources, decRef, getNativeHandle, getResourceLogDescription, isNull, logNativeResources, releaseReferences, removeReferenceTo, setDescription, swapReferenceTo, waitForNoResources

Methods inherited from class java.lang.Object

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

Constructor Detail

EventLoopGroup

public EventLoopGroup(int numThreads)
               throws CrtRuntimeException

Creates a new event loop group for the I/O subsystem to use to run blocking I/O requests

Parameters:

numThreads - The number of threads that the event loop group may run tasks across. Usually 1.

Throws:

CrtRuntimeException - If the system is unable to allocate space for a native event loop group

Method Detail

canReleaseReferencesImmediately

protected boolean canReleaseReferencesImmediately()

Determines whether a resource releases its dependencies at the same time the native handle is released or if it waits. Resources that wait are responsible for calling releaseReferences() manually.

Specified by:

canReleaseReferencesImmediately in class CrtResource

releaseNativeHandle

protected void releaseNativeHandle()

Stops the event loop group's tasks and frees all resources associated with the the group. This should be called after all other clients/connections and other resources are cleaned up, or else they will not clean up completely.

Specified by:

releaseNativeHandle in class CrtResource

getShutdownCompleteFuture

public CompletableFuture<Void> getShutdownCompleteFuture()