You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/Org.Openfeed.Client/Interfaces.cs
+32Lines changed: 32 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -229,6 +229,22 @@ public interface IOpenfeedClient : IDisposable {
229
229
/// <returns>The ID of the subscription which can be used in a call to <see cref="IOpenfeedClient.Unsubscribe(long)"/> to terminate the subscription.</returns>
/// Sends a <see cref="SubscriptionRequest"/> to the server to which we are currently connected. If the client not currently
234
+
/// connected then waits for the connection to be established and then sends the <see cref="SubscriptionRequest"/>.
235
+
/// If the client gets disconnected then it waits for the reconnect and sends the <see cref="SubscriptionRequest"/>.
236
+
/// </summary>
237
+
/// <param name="service">The <see cref="Service"/> to which to subscribe.</param>
238
+
/// <param name="subscriptionTypes">A collection of <see cref="SubscriptionType"/>.</param>
239
+
/// <param name="instrumentTypes">A collection of <see cref="InstrumentType"/>.</param>
240
+
/// <param name="snapshotIntervalSeconds">Setting of the cadence at which the snapshots will be sent. If zero the the snapshot is only
241
+
/// sent once.</param>
242
+
/// <param name="symbols">A collection of symbols to which to subscribe, or null if no symbol subscription is to be made.</param>
243
+
/// <param name="marketIds">A collection of market ID's to which to subscribe, or null if no subscription by market ID's is to be made.</param>
244
+
/// <param name="exchanges">A collection of exchanges to which to subscribe, or null if no subscription by exchange is to be made.</param>
245
+
/// <param name="channels">A collection of channels to which to subscribe, or null if no subscription by channel is to be made.</param>
246
+
/// <returns>The ID of the subscription which can be used in a call to <see cref="IOpenfeedClient.Unsubscribe(long)"/> to terminate the subscription.</returns>
/// Unsubscribes from the feed for a given <paramref name="subscriptionId"/>.
@@ -299,6 +315,22 @@ public interface IOpenfeedConnection {
299
315
/// <returns>The ID of the subscription which can be used in a call to <see cref="IOpenfeedConnection.Unsubscribe(long)"/> to terminate the subscription.</returns>
/// Sends a <see cref="SubscriptionRequest"/> to the server to which we are currently connected. If the connection is no longer
320
+
/// connected throws a <see cref="OpenfeedDisconnectedException"/>.
321
+
/// </summary>
322
+
/// <param name="service">The <see cref="Service"/> to which to subscribe.</param>
323
+
/// <param name="subscriptionTypes">A collection of <see cref="SubscriptionType"/>.</param>
324
+
/// <param name="instrumentTypes">A collection of <see cref="InstrumentType"/>.</param>
325
+
/// <param name="snapshotIntervalSeconds">Setting of the cadence at which the snapshots will be sent. If zero the the snapshot is only
326
+
/// sent once.</param>
327
+
/// <param name="symbols">A collection of symbols to which to subscribe, or null if no symbol subscription is to be made.</param>
328
+
/// <param name="marketIds">A collection of market ID's to which to subscribe, or null if no subscription by market ID's is to be made.</param>
329
+
/// <param name="exchanges">A collection of exchanges to which to subscribe, or null if no subscription by exchange is to be made.</param>
330
+
/// <param name="channels">A collection of channels to which to subscribe, or null if no subscription by channel is to be made.</param>
331
+
/// <returns>The ID of the subscription which can be used in a call to <see cref="IOpenfeedConnection.Unsubscribe(long)"/> to terminate the subscription.</returns>
0 commit comments