Class Libp2pTopic

Represents libp2p pub-sub topics for Coaty communication events (except Raw and external IoValue events).

Hierarchy

Libp2pTopic

Index

Accessors

Methods

Accessors

correlationId

get correlationId(): string

- Defined in src/libp2p-topic.ts:19
Returns string

eventType

get eventType(): CommunicationEventType

- Defined in src/libp2p-topic.ts:11
Returns CommunicationEventType

eventTypeFilter

get eventTypeFilter(): string

- Defined in src/libp2p-topic.ts:15
Returns string

namespace

get namespace(): string

- Defined in src/libp2p-topic.ts:27
Returns string

version

get version(): number

- Defined in src/libp2p-topic.ts:23
Returns number

Methods

Static createByName

createByName(topicName: string): Libp2pTopic

- Defined in src/libp2p-topic.ts:55
Create a new topic instance from the given libp2p publication topic name.

Parameters
- topicName: string
  
  the structured name of a Coaty publication topic
Returns Libp2pTopic

a Coaty communication topic instance or undefined if the topic name represents a Raw or external IoValue event.

Static getTopicFilter

getTopicFilter(version: number, namespace: string, eventType: CommunicationEventType, eventTypeFilter: string, correlationId: Uuid): string

- Defined in src/libp2p-topic.ts:110
Gets a libp2p topic for subscription.

Parameters
- version: number
  
  the protocol version
- namespace: string
- eventType: CommunicationEventType
  
  the event type
- eventTypeFilter: string
  
  the event filter or undefined
- correlationId: Uuid
  
  correlation ID for two-way message, otherwise undefined
Returns string

Static getTopicName

getTopicName(version: number, namespace: string, eventType: CommunicationEventType, eventTypeFilter: string, correlationId: Uuid): string

- Defined in src/libp2p-topic.ts:83
Gets the p2p publication topic name for the given topic levels.

Parameters
- version: number
  
  the protocol version
- namespace: string
- eventType: CommunicationEventType
  
  an event type
- eventTypeFilter: string
  
  a filter for an event type, or undefined
- correlationId: Uuid
  
  correlation ID for two-way message, otherwise undefined
Returns string

Static isCoatyTopicLike

isCoatyTopicLike(topicName: string): boolean

- Defined in src/libp2p-topic.ts:136
Determines whether the given topic name starts with the same topic level as a Coaty topic.

Parameters
- topicName: string
  
  a topic name
Returns boolean

true if the given topic name is a potential Coaty topic; false otherwise

Static isTwoWayRequestEvent

isTwoWayRequestEvent(eventType: CommunicationEventType): boolean

- Defined in src/libp2p-topic.ts:157
Parameters
- eventType: CommunicationEventType
Returns boolean

Static isValidTopic

isValidTopic(name: string, forSubscription?: boolean): boolean

- Defined in src/libp2p-topic.ts:150
Determines whether the given name is a valid libp2p topic for publication or subscription.

Parameters
- name: string
  
  a topic name
- Default value forSubscription: boolean = false
  
  indicates whether the name is used for subscription (true) or publication (false)
Returns boolean

true if the given topic name can be used as requested; false otherwise

Generated using TypeDoc