org.whispersystems.signalservice.api

Class SignalServiceMessagePipe

java.lang.Object

org.whispersystems.signalservice.api.SignalServiceMessagePipe

public class SignalServiceMessagePipe
extends java.lang.Object

A SignalServiceMessagePipe represents a dedicated connection to the Signal Service, which the server can push messages down through.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SignalServiceMessagePipe.MessagePipeCallback For receiving a callback when a new message has been received.

Method Summary

Modifier and Type	Method and Description
SignalServiceEnvelope	read(long timeout, java.util.concurrent.TimeUnit unit) A blocking call that reads a message off the pipe.
SignalServiceEnvelope	read(long timeout, java.util.concurrent.TimeUnit unit, SignalServiceMessagePipe.MessagePipeCallback callback) A blocking call that reads a message off the pipe (see read(long, java.util.concurrent.TimeUnit) Unlike read(long, java.util.concurrent.TimeUnit), this method allows you to specify a callback that will be called before the received message is acknowledged.
void	shutdown() Close this connection to the server.

Methods inherited from class java.lang.Object

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

Method Detail

read

public SignalServiceEnvelope read(long timeout,
                                  java.util.concurrent.TimeUnit unit)
                           throws org.whispersystems.libsignal.InvalidVersionException,
                                  java.io.IOException,
                                  java.util.concurrent.TimeoutException

A blocking call that reads a message off the pipe. When this call returns, the message has been acknowledged and will not be retransmitted.

Parameters:

timeout - The timeout to wait for.

unit - The timeout time unit.

Returns:

A new message.

Throws:

org.whispersystems.libsignal.InvalidVersionException

java.io.IOException

java.util.concurrent.TimeoutException

read

public SignalServiceEnvelope read(long timeout,
                                  java.util.concurrent.TimeUnit unit,
                                  SignalServiceMessagePipe.MessagePipeCallback callback)
                           throws java.util.concurrent.TimeoutException,
                                  java.io.IOException,
                                  org.whispersystems.libsignal.InvalidVersionException

A blocking call that reads a message off the pipe (see read(long, java.util.concurrent.TimeUnit) Unlike read(long, java.util.concurrent.TimeUnit), this method allows you to specify a callback that will be called before the received message is acknowledged. This allows you to write the received message to durable storage before acknowledging receipt of it to the server.

Parameters:

timeout - The timeout to wait for.

unit - The timeout time unit.

callback - A callback that will be called before the message receipt is acknowledged to the server.

Returns:

The message read (same as the message sent through the callback).

Throws:

java.util.concurrent.TimeoutException

java.io.IOException

org.whispersystems.libsignal.InvalidVersionException

shutdown

public void shutdown()

Close this connection to the server.