com.twitter.hbc.httpclient

Class BasicClient

java.lang.Object

com.twitter.hbc.httpclient.BasicClient

All Implemented Interfaces:

Client

public class BasicClient
extends Object
implements Client

This class and classes in this package will depend on HttpClient

Constructor Summary

Constructors

Constructor and Description
BasicClient(String name, Hosts hosts, StreamingEndpoint endpoint, Authentication auth, boolean enableGZip, HosebirdMessageProcessor processor, ReconnectionManager reconnectionManager, RateTracker rateTracker, ExecutorService executorService, BlockingQueue<Event> eventsQueue, org.apache.http.params.HttpParams params, org.apache.http.conn.scheme.SchemeRegistry schemeRegistry)

Method Summary

Methods

Modifier and Type	Method and Description
void	connect() Connects to the endpoint and begins streaming.
StreamingEndpoint	getEndpoint()
Event	getExitEvent() This method should only be called after the client is done
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicClient

public BasicClient(String name,
           Hosts hosts,
           StreamingEndpoint endpoint,
           Authentication auth,
           boolean enableGZip,
           HosebirdMessageProcessor processor,
           ReconnectionManager reconnectionManager,
           RateTracker rateTracker,
           ExecutorService executorService,
           @Nullable
           BlockingQueue<Event> eventsQueue,
           org.apache.http.params.HttpParams params,
           org.apache.http.conn.scheme.SchemeRegistry schemeRegistry)

Method Detail

connect

public 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. Forks a new thread to do the IO in.

Specified by:

connect in interface Client

getStatsTracker

public StatsReporter.StatsTracker getStatsTracker()

Specified by:

getStatsTracker in interface Client

isDone

public boolean isDone()

Specified by:

isDone in interface Client

getExitEvent

public Event getExitEvent()

This method should only be called after the client is done

stop

public void stop()

Description copied from interface: Client

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

Specified by:

stop in interface Client

stop

public void stop(int waitMillis)

Description copied from interface: Client

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

Specified by:

stop in interface Client

Parameters:

waitMillis - milliseconds to wait for the client to stop

getName

public String getName()

Description copied from interface: Client

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

Specified by:

getName in interface Client

getEndpoint

public StreamingEndpoint getEndpoint()

Specified by:

getEndpoint in interface Client

reconnect

public void reconnect()

Specified by:

reconnect in interface Client