Skip to content
This repository has been archived by the owner on Mar 24, 2021. It is now read-only.

Commit

Permalink
update parameter docs for Broker
Browse files Browse the repository at this point in the history
  • Loading branch information
emmettbutler committed Apr 23, 2015
1 parent 8f2481a commit e869f03
Showing 1 changed file with 20 additions and 6 deletions.
26 changes: 20 additions & 6 deletions pykafka/broker.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,26 @@ def __init__(self,
socket_timeout_ms,
offsets_channel_socket_timeout_ms,
buffer_size=64 * 1024):
"""Init a Broker.
:param handler: TODO: Fill in
:type handler: TODO: Fill in
:param timeout: TODO: Fill in
:type timeout: :class:int
"""Create a Broker instance
:param id_: The id number of this broker
:type id_: int
:param host: The host address to which to connect. An IP address or a
DNS name
:type host: str
:param port: The port on which to connect
:type port: int
:param handler: A Handler instance that will be used to service requests
and responses
:type handler: :class:`pykafka.handlers.Handler`
:param socket_timeout_ms: The socket timeout for network requests
:type socket_timeout_ms: int
:param offsets_channel_socket_timeout_ms: The socket timeout for network
requests on the offsets channel
:type offsets_channel_socket_timeout_ms: int
:param buffer_size: The size (bytes) of the internal buffer used to
receive network responses
:type buffer_size: int
"""
self._connection = None
self._offsets_channel_connection = None
Expand Down

0 comments on commit e869f03

Please sign in to comment.