AnnouncementClient AnnouncementClient AnnouncementClient AnnouncementClient Class

Definition

Used by services to send discovery announcement messages. Clients can use the discovery mechanism, specifically the corresponding AnnouncementService class to listen and act on the announcement messages. An announcement message contains information about the service such as its fully-qualified contract name, any scopes that the service is operating in as well as any custom metadata the service wants to send.

public ref class AnnouncementClient sealed : IDisposable, System::ServiceModel::ICommunicationObject
public sealed class AnnouncementClient : IDisposable, System.ServiceModel.ICommunicationObject
type AnnouncementClient = class
    interface ICommunicationObject
    interface IDisposable
Public NotInheritable Class AnnouncementClient
Implements ICommunicationObject, IDisposable
Inheritance
AnnouncementClientAnnouncementClientAnnouncementClientAnnouncementClient
Implements

Remarks

If a service adds the ServiceDiscoveryBehavior behavior and specifies an AnnouncementEndpoint the service automatically sends announcement messages when the service goes online or comes offline. Use this class when you want to explicitly send the announcement messages yourself.

Constructors

AnnouncementClient() AnnouncementClient() AnnouncementClient() AnnouncementClient()

Creates a new instance of the AnnouncementClient class.

AnnouncementClient(AnnouncementEndpoint) AnnouncementClient(AnnouncementEndpoint) AnnouncementClient(AnnouncementEndpoint) AnnouncementClient(AnnouncementEndpoint)

Initializes a new instance of the AnnouncementClient class with the specified AnnouncementEndpoint.

AnnouncementClient(String) AnnouncementClient(String) AnnouncementClient(String) AnnouncementClient(String)

Initializes a new instance of the AnnouncementClient class with the specified endpoint configuration.

Properties

ChannelFactory ChannelFactory ChannelFactory ChannelFactory

Gets the channel factory associated with the AnnouncementClient.

ClientCredentials ClientCredentials ClientCredentials ClientCredentials

Gets the client credentials associated with the AnnouncementClient.

Endpoint Endpoint Endpoint Endpoint

Gets the ServiceEndpoint associated with the AnnouncementClient.

InnerChannel InnerChannel InnerChannel InnerChannel

Gets the inner channel associated with the AnnouncementClient.

MessageSequenceGenerator MessageSequenceGenerator MessageSequenceGenerator MessageSequenceGenerator

Gets or sets the message sequence generator associated with the AnnouncementClient.

Methods

AnnounceOffline(EndpointDiscoveryMetadata) AnnounceOffline(EndpointDiscoveryMetadata) AnnounceOffline(EndpointDiscoveryMetadata) AnnounceOffline(EndpointDiscoveryMetadata)

Causes an offline announcement message (Bye) to be sent with the specified endpoint discovery metadata.

AnnounceOfflineAsync(EndpointDiscoveryMetadata) AnnounceOfflineAsync(EndpointDiscoveryMetadata) AnnounceOfflineAsync(EndpointDiscoveryMetadata) AnnounceOfflineAsync(EndpointDiscoveryMetadata)

Causes an offline announcement message (Bye) to be sent asynchronously with the specified endpoint discovery metadata.

AnnounceOfflineAsync(EndpointDiscoveryMetadata, Object) AnnounceOfflineAsync(EndpointDiscoveryMetadata, Object) AnnounceOfflineAsync(EndpointDiscoveryMetadata, Object) AnnounceOfflineAsync(EndpointDiscoveryMetadata, Object)

Causes an offline announcement message (Bye) to be sent asynchronously with the specified endpoint discovery metadata and user-defined state.

AnnounceOfflineTaskAsync(EndpointDiscoveryMetadata) AnnounceOfflineTaskAsync(EndpointDiscoveryMetadata) AnnounceOfflineTaskAsync(EndpointDiscoveryMetadata) AnnounceOfflineTaskAsync(EndpointDiscoveryMetadata)

Causes an offline task announcement message (Bye) to be sent asynchronously with the specified endpoint discovery metadata.

AnnounceOnline(EndpointDiscoveryMetadata) AnnounceOnline(EndpointDiscoveryMetadata) AnnounceOnline(EndpointDiscoveryMetadata) AnnounceOnline(EndpointDiscoveryMetadata)

Causes an online announcement message (Hello) to be sent.

AnnounceOnlineAsync(EndpointDiscoveryMetadata) AnnounceOnlineAsync(EndpointDiscoveryMetadata) AnnounceOnlineAsync(EndpointDiscoveryMetadata) AnnounceOnlineAsync(EndpointDiscoveryMetadata)

Causes an online announcement (Hello) message to be sent asynchronously with the specified endpoint discovery metadata.

AnnounceOnlineAsync(EndpointDiscoveryMetadata, Object) AnnounceOnlineAsync(EndpointDiscoveryMetadata, Object) AnnounceOnlineAsync(EndpointDiscoveryMetadata, Object) AnnounceOnlineAsync(EndpointDiscoveryMetadata, Object)

Causes an online announcement (Hello) message to be sent asynchronously with the specified endpoint discovery metadata and user-defined state.

AnnounceOnlineTaskAsync(EndpointDiscoveryMetadata) AnnounceOnlineTaskAsync(EndpointDiscoveryMetadata) AnnounceOnlineTaskAsync(EndpointDiscoveryMetadata) AnnounceOnlineTaskAsync(EndpointDiscoveryMetadata)

Causes an online task announcement message (Hello) to be sent asynchronously with the specified endpoint discovery metadata.

BeginAnnounceOffline(EndpointDiscoveryMetadata, AsyncCallback, Object) BeginAnnounceOffline(EndpointDiscoveryMetadata, AsyncCallback, Object) BeginAnnounceOffline(EndpointDiscoveryMetadata, AsyncCallback, Object) BeginAnnounceOffline(EndpointDiscoveryMetadata, AsyncCallback, Object)

Causes an offline announcement (Bye) message to be sent asynchronously with the specified endpoint discovery metadata and user-defined state. The specified AsyncCallback is called when the operation completes.

BeginAnnounceOnline(EndpointDiscoveryMetadata, AsyncCallback, Object) BeginAnnounceOnline(EndpointDiscoveryMetadata, AsyncCallback, Object) BeginAnnounceOnline(EndpointDiscoveryMetadata, AsyncCallback, Object) BeginAnnounceOnline(EndpointDiscoveryMetadata, AsyncCallback, Object)

Causes an online announcement (Hello) message to be sent asynchronously with the specified endpoint discovery metadata and user-defined state. The specified AsyncCallback is called when the operation completes.

Close() Close() Close() Close()

Closes the AnnouncementClient.

EndAnnounceOffline(IAsyncResult) EndAnnounceOffline(IAsyncResult) EndAnnounceOffline(IAsyncResult) EndAnnounceOffline(IAsyncResult)

Waits for a pending asynchronous offline announcement to complete.

EndAnnounceOnline(IAsyncResult) EndAnnounceOnline(IAsyncResult) EndAnnounceOnline(IAsyncResult) EndAnnounceOnline(IAsyncResult)

Waits for a pending asynchronous online announcement to complete.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
Open() Open() Open() Open()

Opens the AnnouncementClient.

ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)

Events

AnnounceOfflineCompleted AnnounceOfflineCompleted AnnounceOfflineCompleted AnnounceOfflineCompleted

Occurs when an asynchronous offline announcement (Bye) completes.

AnnounceOnlineCompleted AnnounceOnlineCompleted AnnounceOnlineCompleted AnnounceOnlineCompleted

Occurs when an asynchronous online announcement (Hello) completes.

Explicit Interface Implementations

ICommunicationObject.Abort() ICommunicationObject.Abort() ICommunicationObject.Abort() ICommunicationObject.Abort()

Causes a communication object to transition immediately from its current state into the closed state.

ICommunicationObject.BeginClose(AsyncCallback, Object) ICommunicationObject.BeginClose(AsyncCallback, Object) ICommunicationObject.BeginClose(AsyncCallback, Object) ICommunicationObject.BeginClose(AsyncCallback, Object)

Begins an asynchronous operation to close a communication object.

ICommunicationObject.BeginClose(TimeSpan, AsyncCallback, Object) ICommunicationObject.BeginClose(TimeSpan, AsyncCallback, Object) ICommunicationObject.BeginClose(TimeSpan, AsyncCallback, Object) ICommunicationObject.BeginClose(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to close a communication object with a specified timeout.

ICommunicationObject.BeginOpen(AsyncCallback, Object) ICommunicationObject.BeginOpen(AsyncCallback, Object) ICommunicationObject.BeginOpen(AsyncCallback, Object) ICommunicationObject.BeginOpen(AsyncCallback, Object)

Begins an asynchronous operation to open a communication object.

ICommunicationObject.BeginOpen(TimeSpan, AsyncCallback, Object) ICommunicationObject.BeginOpen(TimeSpan, AsyncCallback, Object) ICommunicationObject.BeginOpen(TimeSpan, AsyncCallback, Object) ICommunicationObject.BeginOpen(TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to open a communication object within a specified interval of time.

ICommunicationObject.Close() ICommunicationObject.Close() ICommunicationObject.Close() ICommunicationObject.Close()

Causes a communication object to transition from its current state into the closed state.

ICommunicationObject.Close(TimeSpan) ICommunicationObject.Close(TimeSpan) ICommunicationObject.Close(TimeSpan) ICommunicationObject.Close(TimeSpan)

Causes a communication object to transition from its current state into the closed state within a specified interval of time.

ICommunicationObject.Closed ICommunicationObject.Closed ICommunicationObject.Closed ICommunicationObject.Closed

Occurs when the communication object completes its transition from the closing state into the closed state.

ICommunicationObject.Closing ICommunicationObject.Closing ICommunicationObject.Closing ICommunicationObject.Closing

Occurs when the communication object first enters the closing state.

ICommunicationObject.EndClose(IAsyncResult) ICommunicationObject.EndClose(IAsyncResult) ICommunicationObject.EndClose(IAsyncResult) ICommunicationObject.EndClose(IAsyncResult)

Completes an asynchronous operation to close a communication object.

ICommunicationObject.EndOpen(IAsyncResult) ICommunicationObject.EndOpen(IAsyncResult) ICommunicationObject.EndOpen(IAsyncResult) ICommunicationObject.EndOpen(IAsyncResult)

Completes an asynchronous operation to open a communication object.

ICommunicationObject.Faulted ICommunicationObject.Faulted ICommunicationObject.Faulted ICommunicationObject.Faulted

Occurs when the communication object first enters the faulted state.

ICommunicationObject.Open() ICommunicationObject.Open() ICommunicationObject.Open() ICommunicationObject.Open()

Causes a communication object to transition from the created state into the opened state.

ICommunicationObject.Open(TimeSpan) ICommunicationObject.Open(TimeSpan) ICommunicationObject.Open(TimeSpan) ICommunicationObject.Open(TimeSpan)

Causes a communication object to transition from the created state into the opened state within a specified interval of time.

ICommunicationObject.Opened ICommunicationObject.Opened ICommunicationObject.Opened ICommunicationObject.Opened

Occurs when the communication object completes its transition from the opening state into the opened state.

ICommunicationObject.Opening ICommunicationObject.Opening ICommunicationObject.Opening ICommunicationObject.Opening

Occurs when the communication object first enters the opening state.

ICommunicationObject.State ICommunicationObject.State ICommunicationObject.State ICommunicationObject.State

Gets the current state of the communication-oriented object.

IDisposable.Dispose() IDisposable.Dispose() IDisposable.Dispose() IDisposable.Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Applies to