c

io.scalajs.npm.kafkanode

HighLevelConsumer

class HighLevelConsumer extends Object with IEventEmitter

High-Level Consumer

Annotations
@RawJSType() @native() @JSImport( "kafka-node" , "HighLevelConsumer" )
Linear Supertypes
IEventEmitter, Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HighLevelConsumer
  2. IEventEmitter
  3. Object
  4. Any
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HighLevelConsumer(client: Client, payloads: Array[Payload], options: |[ConsumerOptions, RawOptions])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addListener(eventName: String, listener: Function): HighLevelConsumer.this.type
    Definition Classes
    IEventEmitter
  5. def addTopics(topics: String, callback: Function): Unit

    Add topics to current consumer, if any topic to be added not exists, return error

    Add topics to current consumer, if any topic to be added not exists, return error

    Example:
    1. addTopics(topics, callback, fromOffset)

  6. def addTopics(topics: String, callback: Function, fromOffset: Boolean): Unit

    Add topics to current consumer, if any topic to be added not exists, return error

    Add topics to current consumer, if any topic to be added not exists, return error

    Example:
    1. addTopics(topics, callback, fromOffset)

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def close(callback: Function): Unit

    Closes the consumer

    Closes the consumer

    callback

    the callback

    Example:
    1. consumer.close(force, callback)

  10. def close(force: Boolean, callback: Function): Unit

    Closes the consumer

    Closes the consumer

    force

    if set to true, it forces the consumer to commit the current offset before closing, default false

    callback

    the callback

    Example:
    1. consumer.close(force, callback)

  11. def commit(callback: Function): Unit

    Commit offset of the current topics manually, this method should be called when a consumer leaves.

    Commit offset of the current topics manually, this method should be called when a consumer leaves.

    Example:
    1. consumer.commit(function(err, data) { .. });

  12. val domain: String
    Definition Classes
    IEventEmitter
  13. def emit(name: String, args: Any*): Any
    Definition Classes
    IEventEmitter
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  18. def getMaxListeners(): Int
    Definition Classes
    IEventEmitter
  19. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  23. def listenerCount(eventName: String): Int
    Definition Classes
    IEventEmitter
  24. def listeners(eventName: String): Array[Function]
    Definition Classes
    IEventEmitter
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  28. def on(eventName: String, listener: Function): HighLevelConsumer.this.type
    Definition Classes
    IEventEmitter
  29. def once(eventName: String, listener: Function): HighLevelConsumer.this.type
    Definition Classes
    IEventEmitter
  30. def pause(): Unit

    Pauses the consumer

    Pauses the consumer

    Example:
    1. consumer.pause()

  31. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  32. def removeAllListeners(): HighLevelConsumer.this.type
    Definition Classes
    IEventEmitter
  33. def removeAllListeners(eventName: String): HighLevelConsumer.this.type
    Definition Classes
    IEventEmitter
  34. def removeListener(eventName: String, listener: Function): HighLevelConsumer.this.type
    Definition Classes
    IEventEmitter
  35. def removeTopics(topics: Array[String], callback: Function): Unit

    Removes an array of topics

    Removes an array of topics

    topics

    the array of topics to remove

    callback

    the callback

    Example:
    1. consumer.removeTopics(['t1', 't2'], function (err, removed) { .. })

  36. def resume(): Unit

    Resume the consumers

    Resume the consumers

    Example:
    1. consumer.resume()

  37. def setMaxListeners(n: Int): HighLevelConsumer.this.type
    Definition Classes
    IEventEmitter
  38. def setOffset(topic: String, partition: Int, offset: Int): Unit

    Set offset of the given topic

    Set offset of the given topic

    Example:
    1. consumer.setOffset('topic', 0, 0)

  39. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  40. def toLocaleString(): String
    Definition Classes
    Object
  41. def toString(): String
    Definition Classes
    AnyRef → Any
  42. val usingDomains: Boolean
    Definition Classes
    IEventEmitter
  43. def valueOf(): Any
    Definition Classes
    Object
  44. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from IEventEmitter

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped