io.github.ageofwar.telejam.updates

Class UpdateReader

java.lang.Object

io.github.ageofwar.telejam.updates.UpdateReader

All Implemented Interfaces:

java.lang.AutoCloseable

public final class UpdateReader
extends java.lang.Object
implements java.lang.AutoCloseable

Utility class that reads new updates received from a bot.

Constructor Summary

Constructors

Constructor and Description
UpdateReader(Bot bot) Constructs an UpdateReader.
UpdateReader(Bot bot, java.util.function.LongUnaryOperator backOff) Constructs an UpdateReader.

Method Summary

Modifier and Type	Method and Description
int	available() Returns the number of updates that can be read from this update reader without blocking by the next invocation read method for this update reader.
void	close()
void	discardAll() Discards buffered updates and all received updates.
int	getUpdates() Retrieves new updates received from the bot.
Update	read() Reads one update from the stream.
boolean	ready() Tells whether this stream is ready to be read.

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateReader

public UpdateReader(Bot bot,
                    java.util.function.LongUnaryOperator backOff)

Constructs an UpdateReader.

Parameters:

bot - the bot that receive updates

backOff - back off to be used when long polling fails

UpdateReader

public UpdateReader(Bot bot)

Constructs an UpdateReader.

Parameters:

bot - the bot that receive updates

Method Detail

available

public int available()

Returns the number of updates that can be read from this update reader without blocking by the next invocation read method for this update reader. The next invocation might be the same thread or another thread. If the available updates are more than Integer.MAX_VALUE, returns Integer.MAX_VALUE.

Returns:

the number of updates that can be read from this update reader without blocking by the next invocation read method

ready

public boolean ready()

Tells whether this stream is ready to be read.

Returns:

true if the next read() is guaranteed not to block for input, false otherwise. Note that returning false does not guarantee that the next read will block.

read

public Update read()
            throws java.io.IOException,
                   java.lang.InterruptedException

Reads one update from the stream.

Returns:

the read update

Throws:

java.io.IOException - if an I/O Exception occurs

java.lang.InterruptedException - if any thread has interrupted the current thread while waiting for updates

getUpdates

public int getUpdates()
               throws java.io.IOException

Retrieves new updates received from the bot.

Returns:

number of updates received

Throws:

java.io.IOException - if an I/O Exception occurs

discardAll

public void discardAll()
                throws java.io.IOException

Discards buffered updates and all received updates.

Throws:

java.io.IOException - if an I/O Exception occurs

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException