Class RemoteEventsManager
The RemoteEventsManager class is to send and receive remote events The Event class should be used by user code to raise and subscribe to events.
Inheritance
Inherited Members
Namespace: EPiServer.Events.Remote
Assembly: EPiServer.Events.dll
Version: 7.19.2Syntax
[Obsolete("The RemoteEventsManager is now primariy exposed through the IEventBroker interface.", false)]
public sealed class RemoteEventsManagerConstructors
RemoteEventsManager()
Declaration
public RemoteEventsManager()Properties
Enabled
Gets or sets a value indicating whether the RemoteEventsManager is enabled or not
Declaration
public static bool Enabled { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
EventMissingAfterMilliseconds
Gets or sets the amount of time in milliseconds that need to elapse for an event to be considered missing. A missing event can only be detected when an event comes out of sequence (i.e. the sequence number is greater that the last plus one)
Declaration
[Obsolete("This setting, if used, is now set on each individual EventProvider if applicable, e.g. eventTimeout=\"00:00:05\" for WcfEventProvider")]
public static int EventMissingAfterMilliseconds { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
EventReplicationProviders
Get and sets the provider for event replication
Declaration
[Obsolete("RemoteEventsManager do no longer work directly with WCF provider instead it uses EventProviderService")]
public static EventReplicationWCFProviders EventReplicationProviders { get; set; }Property Value
| Type | Description |
|---|---|
| EventReplicationWCFProviders |
HasEventRaiserSite
Gets a value indicating whether this instance has event raiser site.
Declaration
public static bool HasEventRaiserSite { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
IsEventClientConfigured
Gets the is event client configured.
Declaration
public static bool? IsEventClientConfigured { get; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
SiteCount
Gets the number of sites registered with the RemoteEventManager
Declaration
public static int SiteCount { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
SyncRoot
Gets the sync root. The sync root can be used by client code to synchronise thread access to the public members of the class
Declaration
public static object SyncRoot { get; }Property Value
| Type | Description |
|---|---|
| System.Object | The sync root. |
Methods
DeRegisterSite(Guid)
Deregisters the site with the RemoteEventsManager.
Declaration
public static void DeRegisterSite(Guid uniqueId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | uniqueId | The unique id representing the remote site as returned by RegisterSite(String, Byte[], RegistrationType). |
GetReceivedCount(Guid)
Returns the number of event messages received for the event identified by eventId
Declaration
[Obsolete("This method no longer returns an accurate number. Use Event.ReceivedCount for an equivalent number.")]
public static long GetReceivedCount(Guid eventId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | eventId | The id of the event |
Returns
| Type | Description |
|---|---|
| System.Int64 | A System.Int64value |
GetSentCount(Guid)
Returns the number of event messages sent for the event identified by eventId
Declaration
[Obsolete("This method no longer returns an accurate number. Use Event.SentCount for an equivalent number.")]
public static long GetSentCount(Guid eventId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | eventId | The id of the event |
Returns
| Type | Description |
|---|---|
| System.Int64 | A System.Int64value |
RegisterSite(String, Byte[], RegistrationType)
Registers the site with the RemoteEventsManager. Only one site per application domain can be registered with the RegistrationType.EventPublisher value. It is this site's identity that is used when an instance of an Event uses this class to raise a remote event. An exception is thrown if a site is already registered as an event raiser for this application domain.
Declaration
public static Guid RegisterSite(string siteId, byte[] siteSecret, RegistrationType regType)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | siteId | The site id. |
| System.Byte[] | siteSecret | The site secret. |
| RegistrationType | regType | The reg type. |
Returns
| Type | Description |
|---|---|
| System.Guid | A unique id representing the registration. |
Reset()
Removes all registered sites that were previously registered. Avoid using this.
Declaration
public static void Reset()