Subscriber

Overview

Related Modules:

Broadcast

Description:

Defines the subscriber for external interfaces to subsribe to events and data of a topic.

Summary

Data Fields

Variable Name

Description

AddTopic )(IUnknown iUnknown, const Topic topic)

int( 

Adds a specified topic to the Broadcast service.

Subscribe )(IUnknown iUnknown, const Topic topic, Consumer consumer)

int( 

Subscribes to a specified topic for consumers.

ModifyConsumer )(IUnknown iUnknown, const Topic topic, Consumer old, Consumer current)

Consumer ( 

Modifies the consumer of a specified topic.

Unsubscribe )(IUnknown iUnknown, const Topic topic, const Consumer consumer)

Consumer ( 

Unsubscribes from a specified topic.

Details

Field Documentation

AddTopic

  1. int(* Subscriber::AddTopic) ([IUnknown]($api-api-LinkIoT-IUnknown.md) *iUnknown, const [Topic]($api-api-LinkIoT-Broadcast.md#gaf03f5bc94cad32ab628a6cdee09b0542) *topic)

Description:

Adds a specified topic to the Broadcast service.

The specified topic is added by the subscriber. A topic can be subscribed to only after being added.

Parameters:

Name

Description
iUnknown Indicates external interface of the pub/sub feature.
topic Indicates the topic to be subscribed to.

Returns:

Returns EC_SUCCESS if the topic is successfully added; returns other error codes if the topic fails to be added.

ModifyConsumer

  1. [Consumer]($api-api-LinkIoT-Consumer.md)*(* Subscriber::ModifyConsumer) ([IUnknown]($api-api-LinkIoT-IUnknown.md) *iUnknown, const [Topic]($api-api-LinkIoT-Broadcast.md#gaf03f5bc94cad32ab628a6cdee09b0542) *topic, [Consumer]($api-api-LinkIoT-Consumer.md) *old, [Consumer]($api-api-LinkIoT-Consumer.md) *current)

Description:

Modifies the consumer of a specified topic.

Parameters:

Name

Description
iUnknown Indicates the pointer to the external interface of the pub/sub feature.
topic Indicates the pointer to the topic whose consumer will be modified.
old Indicates the pointer to the original consumer of the topic.
current Indicates the pointer to the new consumer of the topic.

Returns:

Returns the pointer of the original consumer if the modification is successful; returns NULL otherwise.

Subscribe

  1. int(* Subscriber::Subscribe) ([IUnknown]($api-api-LinkIoT-IUnknown.md) *iUnknown, const [Topic]($api-api-LinkIoT-Broadcast.md#gaf03f5bc94cad32ab628a6cdee09b0542) *topic, [Consumer]($api-api-LinkIoT-Consumer.md) *consumer)

Description:

Subscribes to a specified topic for consumers.

Call this function on the subscriber. The topic to be subscribed to must have been added to the Broadcast service.

Parameters:

Name

Description
iUnknown Indicates external interface of the pub/sub feature.
topic Indicates the topic to be subscribed to.
consumer Indicates the consumer who subscribes to the topic.

Returns:

Returns EC_SUCCESS if the subscription is successful; returns other error codes if the subscription fails.

Unsubscribe

  1. [Consumer]($api-api-LinkIoT-Consumer.md)*(* Subscriber::Unsubscribe) ([IUnknown]($api-api-LinkIoT-IUnknown.md) *iUnknown, const [Topic]($api-api-LinkIoT-Broadcast.md#gaf03f5bc94cad32ab628a6cdee09b0542) *topic, const [Consumer]($api-api-LinkIoT-Consumer.md) *consumer)

Description:

Unsubscribes from a specified topic.

This function cancels the subscription relationship between the specified topic and consumer.

Parameters:

Name

Description
iUnknown Indicates external interface of the pub/sub feature. This parameter is used to obtain subscription relationships.
topic Indicates the pointer to the topic to unsubscribe from.
consumer Indicates the pointer to the consumer.

Returns:

Returns the pointer of the consumer if the unsubscription is successful; returns NULL otherwise.