Object/Trait

com.snowplowanalytics.snowplow.scalatracker.emitters

TEmitter

Related Docs: trait TEmitter | package emitters

Permalink

object TEmitter

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TEmitter
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Callback = (CollectorParams, CollectorRequest, CollectorResponse) ⇒ Unit

    Permalink

    User-provided callback

  2. case class CollectorFailure(code: Int) extends CollectorResponse with Product with Serializable

    Permalink

    Collector refused an event.

    Collector refused an event. Probably wrong endpoint or outage

  3. case class CollectorParams(host: String, port: Int, https: Boolean) extends Product with Serializable

    Permalink

    Collector preferences

  4. sealed trait CollectorRequest extends Product with Serializable

    Permalink

    Payload (either GET or POST) ready to be send to collector

  5. sealed trait CollectorResponse extends Product with Serializable

    Permalink

    ADT for possible track results

  6. case class CollectorSuccess(code: Int) extends CollectorResponse with Product with Serializable

    Permalink

    Success.

    Success. Collector accepted an event

  7. type EmitterPayload = Map[String, String]

    Permalink

    Low-level representation of event

  8. case class GetCollectorRequest(attempt: Int, payload: EmitterPayload) extends CollectorRequest with Product with Serializable

    Permalink

    Single event, supposed to passed with GET-request

  9. case class PostCollectorRequest(attempt: Int, payload: List[EmitterPayload]) extends CollectorRequest with Product with Serializable

    Permalink

    Multiple events, supposed to passed with POST-request

  10. case class RetriesExceeded(lastResponse: CollectorResponse) extends CollectorResponse with Product with Serializable

    Permalink

    Emitter cannot continue retrying.

    Emitter cannot continue retrying. Note that this is not *response*

  11. case class TrackerFailure(throwable: Throwable) extends CollectorResponse with Product with Serializable

    Permalink

    Other failure.

    Other failure. Timeout or network unavailability

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. object CollectorParams extends Serializable

    Permalink
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def backToQueue(queue: BlockingQueue[CollectorRequest], event: CollectorRequest): Boolean

    Permalink

    Schedule re-adding of a failed event to queue after some delay.

    Schedule re-adding of a failed event to queue after some delay. Delay is calculated based on number of undertaken attempts

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. def httpToCollector(httpResponse: Try[HttpResponse[_]]): CollectorResponse

    Permalink

    Transform implementation-specific response into tracker-specific

  14. def invokeCallback(ec: ExecutionContext, collector: CollectorParams, callback: Option[Callback])(payload: CollectorRequest, result: CollectorResponse): Unit

    Permalink

    Asynchronously execute user-provided callback against event and collector response If callback fails to execute - message will be printed to stderr

    Asynchronously execute user-provided callback against event and collector response If callback fails to execute - message will be printed to stderr

    ec

    thread pool to asynchronously execute callback

    collector

    collector parameters

    callback

    user-provided callback

    payload

    latest *sent* payload

    result

    latest result

  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. def sendAsync(ec: ExecutionContext, collector: CollectorParams, payload: CollectorRequest): Future[HttpResponse[_]]

    Permalink

    Update sent-timestamp and attempt an HTTP request

    Update sent-timestamp and attempt an HTTP request

    ec

    thread pool to send HTTP requests to collector

    collector

    endpoint preferences

    payload

    either GET or POST payload

  20. def submit(originQueue: BlockingQueue[CollectorRequest], ec: ExecutionContext, callback: Option[Callback], collector: CollectorParams, payload: CollectorRequest): Unit

    Permalink

    Attempt a HTTP request.

    Attempt a HTTP request. Return request back to queue if it was unsuccessful and invoke callback.

    originQueue

    reference to queue, where event can be re-added in case of unsuccessful delivery

    ec

    thread pool to send HTTP requests to collector

    collector

    endpoint preferences

    payload

    either GET or POST payload

  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  22. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped