Class BackplaneMessage

Implements a simple message which can be send as a string to the server.

Inheritance

Object

BackplaneMessage

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace:CacheManager.Core.Internal

Assembly:CacheManager.Core.dll

Syntax

public sealed class BackplaneMessage

Properties

| Improve this Doc View Source

Action

Gets or sets the action.

Declaration

public BackplaneAction Action { get; set; }

Property Value

Type	Description
BackplaneAction	The action.

| Improve this Doc View Source

ChangeAction

Gets or sets the cache action.

Declaration

public CacheItemChangedEventAction ChangeAction { get; set; }

Property Value

Type	Description
CacheItemChangedEventAction

| Improve this Doc View Source

Key

Gets or sets the key.

Declaration

public string Key { get; set; }

Property Value

Type	Description
String	The key.

| Improve this Doc View Source

OwnerIdentity

Gets or sets the owner identity.

Declaration

public string OwnerIdentity { get; set; }

Property Value

Type	Description
String	The owner identity.

| Improve this Doc View Source

Region

Gets or sets the region.

Declaration

public string Region { get; set; }

Property Value

Type	Description
String	The region.

Methods

| Improve this Doc View Source

Deserialize(String)

Deserializes the message.

Declaration

public static BackplaneMessage Deserialize(string message)

Parameters

Type	Name	Description
String	message	The message.

Returns

Type	Description
BackplaneMessage	The new BackplaneMessage instance.

Exceptions

Type	Condition
ArgumentException	If message is null.
InvalidOperationException	If the message is not valid.

| Improve this Doc View Source

ForChanged(String, String, CacheItemChangedEventAction)

Creates a new BackplaneMessage for the changed action.

Declaration

public static BackplaneMessage ForChanged(string owner, string key, CacheItemChangedEventAction changeAction)

Parameters

Type	Name	Description
String	owner	The owner.
String	key	The key.
CacheItemChangedEventAction	changeAction	The cache change action.

Returns

Type	Description
BackplaneMessage	The new BackplaneMessage instance.

| Improve this Doc View Source

ForChanged(String, String, String, CacheItemChangedEventAction)

Creates a new BackplaneMessage for the changed action.

Declaration

public static BackplaneMessage ForChanged(string owner, string key, string region, CacheItemChangedEventAction changeAction)

Parameters

Type	Name	Description
String	owner	The owner.
String	key	The key.
String	region	The region.
CacheItemChangedEventAction	changeAction	The cache change action.

Returns

Type	Description
BackplaneMessage	The new BackplaneMessage instance.

| Improve this Doc View Source

ForClear(String)

Creates a new BackplaneMessage for the clear action.

Declaration

public static BackplaneMessage ForClear(string owner)

Parameters

Type	Name	Description
String	owner	The owner.

Returns

Type	Description
BackplaneMessage	The new BackplaneMessage instance.

| Improve this Doc View Source

ForClearRegion(String, String)

Creates a new BackplaneMessage for the clear region action.

Declaration

public static BackplaneMessage ForClearRegion(string owner, string region)

Parameters

Type	Name	Description
String	owner	The owner.
String	region	The region.

Returns

Type	Description
BackplaneMessage	The new BackplaneMessage instance.

Exceptions

Type	Condition
ArgumentNullException	If region is null.

| Improve this Doc View Source

ForRemoved(String, String)

Creates a new BackplaneMessage for the removed action.

Declaration

public static BackplaneMessage ForRemoved(string owner, string key)

Parameters

Type	Name	Description
String	owner	The owner.
String	key	The key.

Returns

Type	Description
BackplaneMessage	The new BackplaneMessage instance.

| Improve this Doc View Source

ForRemoved(String, String, String)

Creates a new BackplaneMessage for the removed action.

Declaration

public static BackplaneMessage ForRemoved(string owner, string key, string region)

Parameters

Type	Name	Description
String	owner	The owner.
String	key	The key.
String	region	The region.

Returns

Type	Description
BackplaneMessage	The new BackplaneMessage instance.

| Improve this Doc View Source

Serialize()

Serializes this instance.

Declaration

public string Serialize()

Returns

Type	Description
String	The string representing this message.