Emitter (library 3.8.1-SNAPSHOT API)

java.lang.Object
- com.meizu.cloud.pushsdk.pushtracer.emitter.Emitter

直接已知子类:: Emitter

public abstract class Emitter
extends java.lang.Object

Emitter for build requests

嵌套类概要

嵌套类
限定符和类型类和说明

static class Emitter.EmitterBuilder
Builder for the Emitter.

嵌套类
限定符和类型	类和说明
`static class`	`Emitter.EmitterBuilder` Builder for the Emitter.

字段概要

字段
限定符和类型	字段和说明
`protected BufferOption`	`bufferOption`
`protected long`	`byteLimitGet`
`protected long`	`byteLimitPost`
`protected Call`	`call`
`protected android.content.Context`	`context`
`protected int`	`emitterTick`
`protected int`	`emptyLimit`
`protected javax.net.ssl.HostnameVerifier`	`hostnameVerifier`
`protected HttpMethod`	`httpMethod`
`protected java.util.concurrent.atomic.AtomicBoolean`	`isRunning`
`protected MediaType`	`JSON`
`protected int`	`POST_STM_BYTES`
`protected int`	`POST_WRAPPER_BYTES`
`protected RequestCallback`	`requestCallback`
`protected RequestSecurity`	`requestSecurity`
`protected int`	`sendLimit`
`protected javax.net.ssl.SSLSocketFactory`	`sslSocketFactory`
`protected java.util.concurrent.TimeUnit`	`timeUnit`
`protected java.lang.String`	`uri`
`protected android.net.Uri.Builder`	`uriBuilder`

构造器概要

构造器
构造器和说明

Emitter(Emitter.EmitterBuilder builder)
Creates an emitter object

构造器
构造器和说明
`Emitter(Emitter.EmitterBuilder builder)` Creates an emitter object

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`abstract void`	`add(DataLoad payload)`
`abstract void`	`add(DataLoad payload, boolean attemptEmit)`
`protected java.util.LinkedList<ReadyRequest>`	`buildRequests(EmittableEvents events)` Returns a list of ReadyRequests which can all be sent regardless of if it is GET or POST
`protected void`	`close(Response response)` close response source
`abstract void`	`flush()` Sends everything in the database to the endpoint.
`BufferOption`	`getBufferOption()`
`long`	`getByteLimitGet()`
`long`	`getByteLimitPost()`
`abstract boolean`	`getEmitterStatus()`
`int`	`getEmitterTick()`
`java.lang.String`	`getEmitterUri()`
`int`	`getEmptyLimit()`
`abstract Store`	`getEventStore()`
`HttpMethod`	`getHttpMethod()`
`RequestCallback`	`getRequestCallback()`
`RequestSecurity`	`getRequestSecurity()`
`int`	`getSendLimit()`
`protected boolean`	`isSuccessfulSend(int code)` Returns truth on if the request was sent successfully.
`protected java.util.LinkedList<RequestResult>`	`performSyncEmit(java.util.LinkedList<ReadyRequest> requests)` Performs a synchronous sending of a list of ReadyRequests.
`protected int`	`requestSender(Request request)` The function responsible for actually sending the request to the collector.
`void`	`setBufferOption(BufferOption option)` Sets whether the buffer should send events instantly or after the buffer has reached it's limit.
`void`	`setEmitterUri(java.lang.String uri)` Updates the URI for the Emitter
`void`	`setHttpMethod(HttpMethod method)` Sets the HttpMethod for the Emitter
`void`	`setRequestSecurity(RequestSecurity security)` Sets the RequestSecurity for the Emitter
`abstract void`	`shutdown()` Shuts the emitter down!

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - POST_WRAPPER_BYTES
```
protected int POST_WRAPPER_BYTES
```
  - POST_STM_BYTES
```
protected int POST_STM_BYTES
```
  - JSON
```
protected final MediaType JSON
```
  - context
```
protected android.content.Context context
```
  - uriBuilder
```
protected android.net.Uri.Builder uriBuilder
```
  - requestCallback
```
protected RequestCallback requestCallback
```
  - httpMethod
```
protected HttpMethod httpMethod
```
  - bufferOption
```
protected BufferOption bufferOption
```
  - requestSecurity
```
protected RequestSecurity requestSecurity
```
  - sslSocketFactory
```
protected javax.net.ssl.SSLSocketFactory sslSocketFactory
```
  - hostnameVerifier
```
protected javax.net.ssl.HostnameVerifier hostnameVerifier
```
  - uri
```
protected java.lang.String uri
```
  - emitterTick
```
protected int emitterTick
```
  - emptyLimit
```
protected int emptyLimit
```
  - sendLimit
```
protected int sendLimit
```
  - byteLimitGet
```
protected long byteLimitGet
```
  - byteLimitPost
```
protected long byteLimitPost
```
  - timeUnit
```
protected java.util.concurrent.TimeUnit timeUnit
```
  - call
```
protected Call call
```
  - isRunning
```
protected java.util.concurrent.atomic.AtomicBoolean isRunning
```
- 构造器详细资料
  - Emitter
```
public Emitter(Emitter.EmitterBuilder builder)
```
    Creates an emitter object
    
    参数:
    
    builder - The builder that constructs an emitter
- 方法详细资料
  - add
```
public abstract void add(DataLoad payload)
```
    参数:
    
    payload - the payload to be added to the EventStore
  - add
```
public abstract void add(DataLoad payload,
                         boolean attemptEmit)
```
    参数:
    
    payload - the payload to be added to the EventStore
    
    attemptEmit - attempt emit to server
  - shutdown
```
public abstract void shutdown()
```
    Shuts the emitter down!
  - flush
```
public abstract void flush()
```
    Sends everything in the database to the endpoint.
  - performSyncEmit
```
protected java.util.LinkedList<RequestResult> performSyncEmit(java.util.LinkedList<ReadyRequest> requests)
```
    Performs a synchronous sending of a list of ReadyRequests.
    
    参数:
    
    requests - the requests to send
    
    返回:
    
    the request results.
  - requestSender
```
protected int requestSender(Request request)
```
    The function responsible for actually sending the request to the collector.
    
    参数:
    
    request - The request to be sent
    
    返回:
    
    a RequestResult
  - close
```
protected void close(Response response)
```
    close response source
    
    参数:
    
    response - the receive response
  - buildRequests
```
protected java.util.LinkedList<ReadyRequest> buildRequests(EmittableEvents events)
```
    Returns a list of ReadyRequests which can all be sent regardless of if it is GET or POST. - Checks if the event is over-sized. - Stores all of the relevant event ids.
    
    参数:
    
    events - a list of EmittableEvents pulled from the database.
    
    返回:
    
    a list of ready to send requests
  - getEventStore
```
public abstract Store getEventStore()
```
    返回:
    
    the emitter event store
  - getEmitterStatus
```
public abstract boolean getEmitterStatus()
```
    返回:
    
    the emitter status
  - isSuccessfulSend
```
protected boolean isSuccessfulSend(int code)
```
    Returns truth on if the request was sent successfully.
    
    参数:
    
    code - the response code
    
    返回:
    
    the truth as to the success
  - setBufferOption
```
public void setBufferOption(BufferOption option)
```
    Sets whether the buffer should send events instantly or after the buffer has reached it's limit. By default, this is set to BufferOption Default.
    
    参数:
    
    option - Set the BufferOption enum to Instant send events upon creation.
  - setHttpMethod
```
public void setHttpMethod(HttpMethod method)
```
    Sets the HttpMethod for the Emitter
    
    参数:
    
    method - the HttpMethod
  - setRequestSecurity
```
public void setRequestSecurity(RequestSecurity security)
```
    Sets the RequestSecurity for the Emitter
    
    参数:
    
    security - the RequestSecurity
  - setEmitterUri
```
public void setEmitterUri(java.lang.String uri)
```
    Updates the URI for the Emitter
    
    参数:
    
    uri - new Emitter URI
  - getEmitterUri
```
public java.lang.String getEmitterUri()
```
    返回:
    
    the emitter uri
  - getRequestCallback
```
public RequestCallback getRequestCallback()
```
    返回:
    
    the request callback method
  - getHttpMethod
```
public HttpMethod getHttpMethod()
```
    返回:
    
    the Emitters request method
  - getBufferOption
```
public BufferOption getBufferOption()
```
    返回:
    
    the buffer option selected for the emitter
  - getRequestSecurity
```
public RequestSecurity getRequestSecurity()
```
    返回:
    
    the request security selected for the emitter
  - getEmitterTick
```
public int getEmitterTick()
```
    返回:
    
    the emitter tick
  - getEmptyLimit
```
public int getEmptyLimit()
```
    返回:
    
    the amount of times the event store can be empty before it is shutdown.
  - getSendLimit
```
public int getSendLimit()
```
    返回:
    
    the emitter send limit
  - getByteLimitGet
```
public long getByteLimitGet()
```
    返回:
    
    the GET byte limit
  - getByteLimitPost
```
public long getByteLimitPost()
```
    返回:
    
    the POST byte limit

类 Emitter

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

POST_WRAPPER_BYTES

POST_STM_BYTES

JSON

context

uriBuilder

requestCallback

httpMethod

bufferOption

requestSecurity

sslSocketFactory

hostnameVerifier

uri

emitterTick

emptyLimit

sendLimit

byteLimitGet

byteLimitPost

timeUnit

call

isRunning

构造器详细资料

Emitter

方法详细资料

add

add

shutdown

flush

performSyncEmit

requestSender

close

buildRequests

getEventStore

getEmitterStatus

isSuccessfulSend

setBufferOption

setHttpMethod

setRequestSecurity

setEmitterUri

getEmitterUri

getRequestCallback

getHttpMethod

getBufferOption

getRequestSecurity

getEmitterTick

getEmptyLimit

getSendLimit

getByteLimitGet

getByteLimitPost