AnnouncementClient Class

.NET Framework (current version)
 

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.

Namespace:   System.ServiceModel.Discovery
Assembly:  System.ServiceModel.Discovery (in System.ServiceModel.Discovery.dll)

System.Object
  System.ServiceModel.Discovery.AnnouncementClient

public sealed class AnnouncementClient : ICommunicationObject, 
	IDisposable

NameDescription
System_CAPS_pubmethodAnnouncementClient()

Creates a new instance of the AnnouncementClient class.

System_CAPS_pubmethodAnnouncementClient(AnnouncementEndpoint)

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

System_CAPS_pubmethodAnnouncementClient(String)

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

NameDescription
System_CAPS_pubpropertyChannelFactory

Gets the channel factory associated with the AnnouncementClient.

System_CAPS_pubpropertyClientCredentials

Gets the client credentials associated with the AnnouncementClient.

System_CAPS_pubpropertyEndpoint

Gets the ServiceEndpoint associated with the AnnouncementClient.

System_CAPS_pubpropertyInnerChannel

Gets the inner channel associated with the AnnouncementClient.

System_CAPS_pubpropertyMessageSequenceGenerator

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

NameDescription
System_CAPS_pubmethodAnnounceOffline(EndpointDiscoveryMetadata)

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

System_CAPS_pubmethodAnnounceOfflineAsync(EndpointDiscoveryMetadata)

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

System_CAPS_pubmethodAnnounceOfflineAsync(EndpointDiscoveryMetadata, Object)

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

System_CAPS_pubmethodAnnounceOfflineTaskAsync(EndpointDiscoveryMetadata)

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

System_CAPS_pubmethodAnnounceOnline(EndpointDiscoveryMetadata)

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

System_CAPS_pubmethodAnnounceOnlineAsync(EndpointDiscoveryMetadata)

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

System_CAPS_pubmethodAnnounceOnlineAsync(EndpointDiscoveryMetadata, Object)

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

System_CAPS_pubmethodAnnounceOnlineTaskAsync(EndpointDiscoveryMetadata)

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

System_CAPS_pubmethodBeginAnnounceOffline(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.

System_CAPS_pubmethodBeginAnnounceOnline(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.

System_CAPS_pubmethodClose()

Closes the AnnouncementClient.

System_CAPS_pubmethodEndAnnounceOffline(IAsyncResult)

Waits for a pending asynchronous offline announcement to complete.

System_CAPS_pubmethodEndAnnounceOnline(IAsyncResult)

Waits for a pending asynchronous online announcement to complete.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodOpen()

Opens the AnnouncementClient.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubeventAnnounceOfflineCompleted

Occurs when an asynchronous offline announcement (Bye) completes.

System_CAPS_pubeventAnnounceOnlineCompleted

Occurs when an asynchronous online announcement (Hello) completes.

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_priveventICommunicationObject.Closed

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

System_CAPS_pubinterfaceSystem_CAPS_priveventICommunicationObject.Closing

Occurs when the communication object first enters the closing state.

System_CAPS_pubinterfaceSystem_CAPS_priveventICommunicationObject.Faulted

Occurs when the communication object first enters the faulted state.

System_CAPS_pubinterfaceSystem_CAPS_priveventICommunicationObject.Opened

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

System_CAPS_pubinterfaceSystem_CAPS_priveventICommunicationObject.Opening

Occurs when the communication object first enters the opening state.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIDisposable.Dispose()

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodICommunicationObject.Abort()

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodICommunicationObject.BeginClose(AsyncCallback, Object)

Begins an asynchronous operation to close a communication object.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICommunicationObject.BeginClose(TimeSpan, AsyncCallback, Object)

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodICommunicationObject.BeginOpen(AsyncCallback, Object)

Begins an asynchronous operation to open a communication object.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICommunicationObject.BeginOpen(TimeSpan, AsyncCallback, Object)

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodICommunicationObject.Close()

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodICommunicationObject.Close(TimeSpan)

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodICommunicationObject.EndClose(IAsyncResult)

Completes an asynchronous operation to close a communication object.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICommunicationObject.EndOpen(IAsyncResult)

Completes an asynchronous operation to open a communication object.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICommunicationObject.Open()

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodICommunicationObject.Open(TimeSpan)

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

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICommunicationObject.State

Gets the current state of the communication-oriented object.

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.

.NET Framework
Available since 4.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: