Skip to content

Commit

Permalink
Fix doc comment
Browse files Browse the repository at this point in the history
  • Loading branch information
pepone committed Jan 10, 2025
1 parent 5a0ed4a commit e7263d0
Showing 1 changed file with 1 addition and 16 deletions.
17 changes: 1 addition & 16 deletions cpp/src/DataStorm/Contract.ice
Original file line number Diff line number Diff line change
Expand Up @@ -403,29 +403,14 @@ module DataStormContract
/// @see Lookup::announceTopicReader
void initiateCreateSession(Node* publisher);

/// Initiate the creation of a subscriber session with a node, after the target node has announced a topic
/// writer for which this node has a corresponding topic reader, or after the node has called
/// Node::initiateCreateSession.
/// The publisher node dispatching this request would send a confirmCreateSession to the given subscriber
/// node to continue with the session establishment or ignore the request if it already has an active session
/// with the given subscriber node.
///
/// @param subscriber The subscriber node initiating the session. The proxy is never null.
/// @param session The subscriber session being created. The proxy is never null.
/// @param fromRelay Indicates if the session is being created from a relay node.
/// @param subscriberIsHostedOnRelay Indicates whether the relay is hosting a forwarder for the subscriber or
/// not. The relay will not host a forwarder object when the provided subscriber has endpoints or an adapter-id
/// in this case it is expected that the publisher send request directly to the subscriber node without going
/// through the forwarder.

/// Initiates the creation of a subscriber session with a node. The subscriber node sends this request to a
/// publisher node in one of the following scenarios:
///
/// - The subscriber has received a topic writer announcement from the publisher and has a matching topic
/// reader.
/// - The publisher node has previously send a initiateCreateSession request.
///
/// The publisher node dispatching this request sends a confirmCreateSession request to the subscriber node
/// The publisher node dispatching this request would send a confirmCreateSession request to the subscriber node
/// to continue session establishment. If an active session already exists with the subscriber node, the
/// request is ignored.
///
Expand Down

0 comments on commit e7263d0

Please sign in to comment.