Interface INotificationRegistration

This represents the registration state of the associated listener on the server.

Inherited Members

IRegistration.CloseAsync()

Namespace: PushTechnology.ClientInterface.Client.Features.Control.Topics

Assembly: Diffusion.Client.dll

Syntax

public interface INotificationRegistration : IRegistration

Remarks

This registration also provides operations to control which topic paths the listener will receive notifications for.

Methods

DeselectAsync(ITopicSelector)

Requests to stop receiving notifications for all topics matched by the given selector.

Declaration

Task<object> DeselectAsync(ITopicSelector selector)

Parameters

Type	Name	Description
ITopicSelector	selector	The selector to register.

Returns

Type	Description
Task<System.Object>	The Task representing the current operation.

Remarks

If the operation completes successfully, the Task result will be null.

Caution

Deprecated since 6.4. Topic selectors are no longer verified locally by the client library. Instead System.String expressions will be sent to (and verified by) the Diffusion server. This method will be removed in a future release.

Exceptions

Type	Condition
SessionSecurityException	The calling session does not have SELECT_TOPIC permission for the path prefix of the selector expression. Thrown by the returned Task.
SessionClosedException	The calling session is closed. Thrown by the returned Task.

DeselectAsync(ITopicSelector, CancellationToken)

Requests to stop receiving notifications for all topics matched by the given selector.

Declaration

Task<object> DeselectAsync(ITopicSelector selector, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ITopicSelector	selector	The selector to register.
CancellationToken	cancellationToken	The cancellation token used to cancel the current operation.

Returns

Type	Description
Task<System.Object>	The Task representing the current operation.

Remarks

If the operation completes successfully, the Task result will be null.

This method is the same as calling DeselectAsync(ITopicSelector, CancellationToken) with System.Threading.CancellationToken.None.

Caution

Deprecated since 6.4. Topic selectors are no longer verified locally by the client library. Instead System.String expressions will be sent to (and verified by) the Diffusion server. This method will be removed in a future release.

Exceptions

Type	Condition
SessionSecurityException	The calling session does not have SELECT_TOPIC permission for the path prefix of the selector expression. Thrown by the returned Task.
SessionClosedException	The calling session is closed. Thrown by the returned Task.

See Also

DeselectAsync(ITopicSelector)

DeselectAsync(String)

Requests to stop receiving notifications for all topics matched by the given selector.

Declaration

Task<object> DeselectAsync(string selector)

Parameters

Type	Name	Description
System.String	selector	The selector to register.

Returns

Type	Description
Task<System.Object>	The Task representing the current operation.

Remarks

If the operation completes successfully, the Task result will be null.

This is equivalent to calling DeselectAsync(ITopicSelector) with a selector parsed using Parse(String).

This method is the same as calling DeselectAsync(String, CancellationToken) with System.Threading.CancellationToken.None.

The given selector expression will be evaluated by the server.

Exceptions

Type	Condition
SessionSecurityException	The calling session does not have SELECT_TOPIC permission for the path prefix of the selector expression. Thrown by the returned Task.
SessionClosedException	The calling session is closed. Thrown by the returned Task.

See Also

DeselectAsync(ITopicSelector)

DeselectAsync(String, CancellationToken)

DeselectAsync(String, CancellationToken)

Requests to stop receiving notifications for all topics matched by the given selector.

Declaration

Task<object> DeselectAsync(string selector, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	selector	The selector to register.
CancellationToken	cancellationToken	The cancellation token used to cancel the current operation.

Returns

Type	Description
Task<System.Object>	The Task representing the current operation.

Remarks

If the operation completes successfully, the Task result will be null.

This is equivalent to calling DeselectAsync(ITopicSelector) with a selector parsed using Parse(String).

The given selector expression will be evaluated by the server.

Exceptions

Type	Condition
SessionSecurityException	The calling session does not have SELECT_TOPIC permission for the path prefix of the selector expression. Thrown by the returned Task.
SessionClosedException	The calling session is closed. Thrown by the returned Task.

See Also

DeselectAsync(ITopicSelector, CancellationToken)

SelectAsync(ITopicSelector)

Requests to receive notifications for all topics matched by the provided topic selector.

Declaration

Task<object> SelectAsync(ITopicSelector selector)

Parameters

Type	Name	Description
ITopicSelector	selector	The selector to register.

Returns

Type	Description
Task<System.Object>	The Task representing the current operation.

Remarks

If the operation completes successfully, the Task result will be null.

This method is the same as calling SelectAsync(ITopicSelector, CancellationToken) with System.Threading.CancellationToken.None.

Caution

Deprecated since 6.4. Topic selectors are no longer verified locally by the client library. Instead System.String expressions will be sent to (and verified by) the Diffusion server. This method will be removed in a future release.

Exceptions

Type	Condition
SessionSecurityException	The calling session does not have SELECT_TOPIC permission for the path prefix of the selector expression. Thrown by the returned Task.
SessionClosedException	The calling session is closed. Thrown by the returned Task.

See Also

SelectAsync(ITopicSelector, CancellationToken)

SelectAsync(ITopicSelector, CancellationToken)

Requests to receive notifications for all topics matched by the provided topic selector.

Declaration

Task<object> SelectAsync(ITopicSelector selector, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ITopicSelector	selector	The selector to register.
CancellationToken	cancellationToken	The cancellation token used to cancel the current operation.

Returns

Type	Description
Task<System.Object>	The Task representing the current operation.

Remarks

If the operation completes successfully, the Task result will be null.

Caution

Deprecated since 6.4. Topic selectors are no longer verified locally by the client library. Instead System.String expressions will be sent to (and verified by) the Diffusion server. This method will be removed in a future release.

Exceptions

Type	Condition
SessionSecurityException	The calling session does not have SELECT_TOPIC permission for the path prefix of the selector expression. Thrown by the returned Task.
SessionClosedException	The calling session is closed. Thrown by the returned Task.

SelectAsync(String)

Requests to receive notifications for all topics matched by the provided selector.

Declaration

Task<object> SelectAsync(string selector)

Parameters

Type	Name	Description
System.String	selector	The selector to register.

Returns

Type	Description
Task<System.Object>	The Task representing the current operation.

Remarks

If the operation completes successfully, the Task result will be null.

This is equivalent to calling SelectAsync(ITopicSelector) with a selector parsed using Parse(String).

This method is the same as calling SelectAsync(String, CancellationToken) with System.Threading.CancellationToken.None.

The given selector expression will be evaluated by the server.

Exceptions

Type	Condition
SessionSecurityException	The calling session does not have SELECT_TOPIC permission for the path prefix of the selector expression. Thrown by the returned Task.
SessionClosedException	The calling session is closed. Thrown by the returned Task.

See Also

SelectAsync(ITopicSelector)

SelectAsync(String, CancellationToken)

SelectAsync(String, CancellationToken)

Requests to receive notifications for all topics matched by the provided selector.

Declaration

Task<object> SelectAsync(string selector, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	selector	The selector to register.
CancellationToken	cancellationToken	The cancellation token used to cancel the current operation.

Returns

Type	Description
Task<System.Object>	The Task representing the current operation.

Remarks

If the operation completes successfully, the Task result will be null.

This is equivalent to calling SelectAsync(ITopicSelector) with a selector parsed using Parse(String).

The given selector expression will be evaluated by the server.

Exceptions

Type	Condition
SessionSecurityException	The calling session does not have SELECT_TOPIC permission for the path prefix of the selector expression. Thrown by the returned Task.
SessionClosedException	The calling session is closed. Thrown by the returned Task.

See Also

SelectAsync(ITopicSelector, CancellationToken)