Transmission (libhoney-java 0.0.1 API)

java.lang.Object
- io.honeycomb.Transmission

```
public class Transmission
extends Object
```
Sends messages and receives responses with honeycomb.io.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Transmission.Builder
Transmission.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`Transmission.Builder` Transmission.Builder

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes Transmission by enqueuing a POISON_PILL which causes each thread to return, then shuts down the executor and awaits this.closeTimeout seconds before timing out.
`protected org.json.JSONObject`	`createJsonError(String error, String metadata)` Returns a JSONObject indicating that a specified error has occurred.
`void`	`enqueueRequest(Object event)` Adds a Event to this Transmission's request queue.
`void`	`enqueueResponse(org.json.JSONObject json)` Adds a JSONObject to this Transmission's response queue.
`String`	`getApiHost()` Returns the API host for this Transmission.
`boolean`	`getBlockOnResponse()` Returns true if this Transmission should block on response.
`boolean`	`getBlockOnSend()` Returns true if this Transmission should block on send.
`int`	`getCloseTimeout()` Returns number of seconds Transmission's close method will wait before timing out.
`Executor`	`getExecutor()` Returns this Transmission's thread executor.
`int`	`getMaxConcurrentBranches()` Returns the number of threads to be instantiated on construction.
`Queue`	`getRequestQueue()` Returns this Transmission's queue of requests to be sent.
`Queue`	`getResponseQueue()` Return this Transmission's queue of received responses.
`boolean`	`isShutdown()` Returns true if all threads are shutdown.
`protected void`	`send(Event event)` Send an HTTP request based on a Event, wait for a response, then enqueue the response.
`void`	`sendDroppedResponse(String metadata)` Enqueue a response indicating that a Event was dropped due to sample rate, including its metadata string.
`void`	`setApiHost(String apiHost)` Sets the api host
`void`	`setBlockOnResponse(boolean blockOnResponse)` Sets if threads should block on response
`void`	`setBlockOnSend(boolean blockOnSend)` Sets if threads should block on send
`void`	`setCloseTimeout(int closeTimeout)` Sets the thread .close timeout
`protected void`	`setRequestQueue(ArrayBlockingQueue requestQueue)` Sets the request queue (for debugging purposes)
`protected void`	`setResponseQueue(ArrayBlockingQueue responseQueue)` Sets the response queue (for debugging purposes)
`void`	`setUserAgent(String userAgent)` Sets the user agent
`org.json.JSONObject`	`toJson()` Returns a JSON representation of this Transmission.
`String`	`toString()` Returns a string representation of this Transmission.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - close
```
public void close()
```
    Closes Transmission by enqueuing a POISON_PILL which causes each thread to return, then shuts down the executor and awaits this.closeTimeout seconds before timing out.
  - createJsonError
```
protected org.json.JSONObject createJsonError(String error,
                                              String metadata)
```
    Returns a JSONObject indicating that a specified error has occurred.
    
    Parameters:
    
    error - string describing specified error
    
    metadata - metadata string used for debugging
    
    Returns:
    
    a JSONObject indicating that a specified error has occurred
  - enqueueRequest
```
public void enqueueRequest(Object event)
```
    Adds a Event to this Transmission's request queue.
    
    Parameters:
    
    event - Event to be enqueued
  - enqueueResponse
```
public void enqueueResponse(org.json.JSONObject json)
```
    Adds a JSONObject to this Transmission's response queue.
    
    Parameters:
    
    json - JSONObject to be enqueued
  - getApiHost
```
public String getApiHost()
```
    Returns the API host for this Transmission.
    
    Returns:
    
    the API host for this Transmission
  - getBlockOnResponse
```
public boolean getBlockOnResponse()
```
    Returns true if this Transmission should block on response.
    
    Returns:
    
    true if this Transmission should block on response
  - getBlockOnSend
```
public boolean getBlockOnSend()
```
    Returns true if this Transmission should block on send.
    
    Returns:
    
    true if this Transmission should block on send
  - getCloseTimeout
```
public int getCloseTimeout()
```
    Returns number of seconds Transmission's close method will wait before timing out.
    
    Returns:
    
    number of seconds Transmission's close method will wait before timing out
  - getExecutor
```
public Executor getExecutor()
```
    Returns this Transmission's thread executor.
    
    Returns:
    
    this Transmission's thread executor
  - getRequestQueue
```
public Queue getRequestQueue()
```
    Returns this Transmission's queue of requests to be sent.
    
    Returns:
    
    this Transmission's queue of requests to be sent.
  - getResponseQueue
```
public Queue getResponseQueue()
```
    Return this Transmission's queue of received responses.
    
    Returns:
    
    this Transmission's queue of received responses.
  - getMaxConcurrentBranches
```
public int getMaxConcurrentBranches()
```
    Returns the number of threads to be instantiated on construction.
    
    Returns:
    
    the number of threads to be instantiated on construction
  - isShutdown
```
public boolean isShutdown()
```
    Returns true if all threads are shutdown.
    
    Returns:
    
    true if all threads are shutdown
  - send
```
protected void send(Event event)
```
    Send an HTTP request based on a Event, wait for a response, then enqueue the response.
    
    Parameters:
    
    event - HonyEvent from which the HTTP request is built
  - sendDroppedResponse
```
public void sendDroppedResponse(String metadata)
```
    Enqueue a response indicating that a Event was dropped due to sample rate, including its metadata string.
    
    Parameters:
    
    metadata - metadata string used for debugging
  - setApiHost
```
public void setApiHost(String apiHost)
```
    Sets the api host
    
    Parameters:
    
    apiHost - api host
  - setRequestQueue
```
protected void setRequestQueue(ArrayBlockingQueue requestQueue)
```
    Sets the request queue (for debugging purposes)
    
    Parameters:
    
    requestQueue - request queue
  - setResponseQueue
```
protected void setResponseQueue(ArrayBlockingQueue responseQueue)
```
    Sets the response queue (for debugging purposes)
    
    Parameters:
    
    responseQueue - response queue
  - setBlockOnResponse
```
public void setBlockOnResponse(boolean blockOnResponse)
```
    Sets if threads should block on response
    
    Parameters:
    
    blockOnResponse - block on response
  - setBlockOnSend
```
public void setBlockOnSend(boolean blockOnSend)
```
    Sets if threads should block on send
    
    Parameters:
    
    blockOnSend - block on send
  - setCloseTimeout
```
public void setCloseTimeout(int closeTimeout)
```
    Sets the thread .close timeout
    
    Parameters:
    
    closeTimeout - .close timeout
  - setUserAgent
```
public void setUserAgent(String userAgent)
```
    Sets the user agent
    
    Parameters:
    
    userAgent - userAgent
  - toJson
```
public org.json.JSONObject toJson()
```
    Returns a JSON representation of this Transmission.
    
    Returns:
    
    a JSON representation of this Transmission
  - toString
```
public String toString()
```
    Returns a string representation of this Transmission.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of this Transmission

Class Transmission

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

close

createJsonError

enqueueRequest

enqueueResponse

getApiHost

getBlockOnResponse

getBlockOnSend

getCloseTimeout

getExecutor

getRequestQueue

getResponseQueue

getMaxConcurrentBranches

isShutdown

send

sendDroppedResponse

setApiHost

setRequestQueue

setResponseQueue

setBlockOnResponse

setBlockOnSend

setCloseTimeout

setUserAgent

toJson

toString