com.twitter.hbc.core

Interface Client

All Known Implementing Classes:

BasicClient

public interface Client

Method Summary

Methods

Modifier and Type	Method and Description
void	connect() Connects to the endpoint and begins streaming.
StreamingEndpoint	getEndpoint()
String	getName() Name of the client used for logging and other diagnostic purposes.
StatsReporter.StatsTracker	getStatsTracker()
boolean	isDone()
void	reconnect()
void	stop() Permanently stops the current connection and does any necessary cleanup.
void	stop(int waitMillis) Permanently stops the current connection and does any necessary cleanup.

Method Detail

connect

void connect()

Connects to the endpoint and begins streaming. Should handle unexpected disconnects by reconnecting with appropriate backoffs/backfill param Should only be called once.

reconnect

void reconnect()

stop

void stop()

Permanently stops the current connection and does any necessary cleanup. Waits until the connection isDone(). Note: after being called, neither connect() nor reconnect() is possible.

stop

void stop(int waitMillis)

Permanently stops the current connection and does any necessary cleanup. Waits up to waitMillis milliseconds for the connection to be isDone(). Note: after being called, neither connect() nor reconnect() is permitted.

Parameters:

waitMillis - milliseconds to wait for the client to stop

isDone

boolean isDone()

getName

String getName()

Name of the client used for logging and other diagnostic purposes.

getEndpoint

StreamingEndpoint getEndpoint()

getStatsTracker

StatsReporter.StatsTracker getStatsTracker()