Skip to content

consumer-push.md

Latest commit

 

History

History
81 lines (57 loc) · 2.07 KB

consumer-push.md

File metadata and controls

81 lines (57 loc) · 2.07 KB

Api docs

1. Push Consumer

  • consumer = CreatePushConsumer(consumerGroup)

    • function description
      create a push consumer instance, by setting consumer group

    • input
      consumerGroup: consumer group

    • return
      consumer: consumer instance

  • SetPushConsumerNameServerAddress(consumer, namesrv)

    • function description
      set name srv address for the consumer instance

    • input
      consumer: consumer intance
      namesrv: name srv address. like : 127.0.0.1:9876

    • return : no

  • Subscribe(consumer, topic, tag)

    • function description
      make consumer subscribe the topic and tag

    • input
      consumer: consumer intance
      topic: topic name tag: topic tag

  • RegisterMessageCallback(consumer, pyCallBack, pyArgs)

    • function description
      set callback for push consumer instance

    • input
      consumer: consumer intance
      pyCallBack: py callback method. when message pulled, they would be send to a pyCallback method
      pyArgs: the arguments will be passed to pyCallBack

  • SetPushConsumerThreadCount(consumer, threadCount)

    • function description
      set push consumer thread count

    • input
      consumer: consumer intance
      threadCount: thread count

  • SetPushConsumerMessageBatchMaxSize(consumer, batchSize)

    • function description
      set message count for one push

    • input
      consumer: consumer intance
      batchSize: message count

  • SetPushConsumerInstanceName(consumer, instanceName)

    • function description
      set consumer instance name

    • input
      consumer: consumer intance
      instanceName: consumer instance name

  • SetPushConsumerSessionCredentials(consumer, accessKey, secretKey,channel)

    • function description
      set consumer access keys

    • input
      consumer: consumer intance
      accessKey: accessKey
      secretKey: secretKey
      channel: channel