me.lucko.helper.messaging.util

Class ChannelPublisher<T>

java.lang.Object

me.lucko.helper.messaging.util.ChannelPublisher<T>

Type Parameters:

T - the message type

All Implemented Interfaces:

AutoCloseable, Terminable

public final class ChannelPublisher<T>
extends Object
implements Terminable

Periodically publishes a message to a channel.

Field Summary

Fields inherited from interface me.lucko.helper.terminable.Terminable

EMPTY

Method Summary

Modifier and Type	Method and Description
void	close() Closes this resource.
static <T> ChannelPublisher<T>	create(Channel<T> channel, long duration, TimeUnit unit, Supplier<? extends T> supplier) Creates a new channel publisher.
static <T> ChannelPublisher<T>	create(Channel<T> channel, long duration, TimeUnit unit, ThreadContext threadContext, Supplier<? extends T> supplier) Creates a new channel publisher.
Channel<T>	getChannel() Gets the channel

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.lucko.helper.terminable.Terminable

bindWith, closeAndReportException, closeSilently, isClosed

Method Detail

create

@Nonnull
public static <T> ChannelPublisher<T> create(@Nonnull
                                                      Channel<T> channel,
                                                      long duration,
                                                      @Nonnull
                                                      TimeUnit unit,
                                                      @Nonnull
                                                      ThreadContext threadContext,
                                                      @Nonnull
                                                      Supplier<? extends T> supplier)

Creates a new channel publisher.

Type Parameters:

T - the type of the message

Parameters:

channel - the channel

duration - the duration to wait between publishing

unit - the unit of duration

threadContext - the context to call the supplier in

supplier - the message supplier

Returns:

a channel publisher

create

@Nonnull
public static <T> ChannelPublisher<T> create(@Nonnull
                                                      Channel<T> channel,
                                                      long duration,
                                                      @Nonnull
                                                      TimeUnit unit,
                                                      @Nonnull
                                                      Supplier<? extends T> supplier)

Creates a new channel publisher.

Type Parameters:

T - the type of the message

Parameters:

channel - the channel

duration - the duration to wait between publishing

unit - the unit of duration

supplier - the message supplier

Returns:

a channel publisher

getChannel

public Channel<T> getChannel()

Gets the channel

Returns:

the channel

close

public void close()

Description copied from interface: Terminable

Closes this resource.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Terminable