System.Runtime.Remoting.Channels.BaseChannelSinkWithProperties Class

Summary

Provides a base implementation for channel sinks that want to expose a dictionary interface to their properties.

C# Syntax:

public abstract class BaseChannelSinkWithProperties : BaseChannelObjectWithProperties

Channel sinks provide a plug-in point that allows access to the underlying messages flowing through the channel as well as the stream used by the transport mechanism to send messages to a remote object. Channel sinks are linked together in a chain of channel sink providers, and all channel messages flow through this chain of sinks before the message is serialized and transported.

Notes to inheritors: When you inherit from BaseChannelSinkWithProperties, you must implement the BaseChannelObjectWithProperties.Keys property and the BaseChannelObjectWithProperties.Item property.

System.Runtime.Remoting.Channels Namespace

System.Runtime.Remoting.Channels.BaseChannelSinkWithProperties Member List:

Public Properties

Count (inherited from System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties)	Read-only See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Count Gets the number of properties associated with the current channel object.
IsFixedSize (inherited from System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties)	Read-only See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.IsFixedSize Gets a Boolean value indicating whether the number of properties that can be entered into the current channel object is fixed.
IsReadOnly (inherited from System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties)	Read-only See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.IsReadOnly Gets a Boolean value indicating whether the collection of properties in the current channel object is read-only.
IsSynchronized (inherited from System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties)	Read-only See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.IsSynchronized Gets a value indicating whether the current dictionary of channel object properties is synchronized.
Item (inherited from System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties)	Read-write See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Item Gets or sets the property associated with the specified key.
Keys (inherited from System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties)	Read-only See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Keys When implemented by a derived class, gets an ICollection of keys that the channel object properties are associated with.
Properties (inherited from System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties)	Read-only See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Properties Gets an IDictionary of the channel properties associated with the current channel object.
SyncRoot (inherited from System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties)	Read-only See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.SyncRoot Gets an object that is used to synchronize access to the BaseChannelObjectWithProperties.
Values (inherited from System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties)	Read-only See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Values Gets an ICollection of the values of the properties associated with the current channel object.

Public Methods

Add (inherited from System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties)	See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Add The current method must not be implemented because it does not apply to the way IDictionary is being used in this case, and because BaseChannelObjectWithProperties.IsFixedSize returns true.
Clear (inherited from System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties)	See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Clear The current method must not be implemented because it does not apply to the way IDictionary is being used in this case, and because BaseChannelObjectWithProperties.IsFixedSize returns true.
Contains (inherited from System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties)	See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Contains Returns a Boolean value indicating whether the current channel object contains a property associated with the specified key.
CopyTo (inherited from System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties)	See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.CopyTo The current method is not supported by the BaseChannelObjectWithProperties.
Equals (inherited from System.Object)	See base class member description: System.Object.Equals Derived from System.Object, the primary base class for all objects.
GetEnumerator (inherited from System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties)	See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.GetEnumerator Returns an IDictionaryEnumerator that enumerates over all the properties associated with the current channel object.
GetHashCode (inherited from System.Object)	See base class member description: System.Object.GetHashCode Derived from System.Object, the primary base class for all objects.
GetType (inherited from System.Object)	See base class member description: System.Object.GetType Derived from System.Object, the primary base class for all objects.
Remove (inherited from System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties)	See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Remove The current method must not be implemented because it does not apply to the way IDictionary is being used in this case, and because BaseChannelObjectWithProperties.IsFixedSize returns true.
ToString (inherited from System.Object)	See base class member description: System.Object.ToString Derived from System.Object, the primary base class for all objects.

Protected Constructors

ctor #1

Default constructor. This constructor is called by derived class constructors to initialize state in this type. Initializes a new instance of the BaseChannelSinkWithProperties class.

Protected Methods

Finalize (inherited from System.Object)	See base class member description: System.Object.Finalize Derived from System.Object, the primary base class for all objects.
MemberwiseClone (inherited from System.Object)	See base class member description: System.Object.MemberwiseClone Derived from System.Object, the primary base class for all objects.

Hierarchy:

• System.Object
• System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties
• System.Runtime.Remoting.Channels.BaseChannelSinkWithProperties

System.Runtime.Remoting.Channels.BaseChannelSinkWithProperties Member Details

Summary

Initializes a new instance of the BaseChannelSinkWithProperties class.

Default constructor. This constructor is called by derived class constructors to initialize state in this type.

C# Syntax:

protected BaseChannelSinkWithProperties();

Channel sinks are linked together in a chain of channel sink providers and all channel messages flow through this chain of sinks before the message is serialized and transported.

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Count

Summary

Gets the number of properties associated with the current channel object.

C# Syntax:

public virtual int Count {get;}

Implements:

ICollection.Count

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.IsFixedSize

Summary

Gets a Boolean value indicating whether the number of properties that can be entered into the current channel object is fixed.

C# Syntax:

public virtual bool IsFixedSize {get;}

Implements:

IDictionary.IsFixedSize

In the current implementation BaseChannelObjectWithProperties.IsFixedSize returns true.

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.IsReadOnly

Summary

Gets a Boolean value indicating whether the collection of properties in the current channel object is read-only.

C# Syntax:

public virtual bool IsReadOnly {get;}

Implements:

IDictionary.IsReadOnly

In the current implementation BaseChannelObjectWithProperties.IsReadOnly returns false.

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.IsSynchronized

Summary

Gets a value indicating whether the current dictionary of channel object properties is synchronized.

C# Syntax:

public virtual bool IsSynchronized {get;}

Implements:

ICollection.IsSynchronized

The current implementation of BaseChannelObjectWithProperties.IsSynchronized returns false.

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Item

Summary

Gets or sets the property associated with the specified key.

C# Syntax:

public virtual object this[object key] {get; set;}

key

The key the requested property is associated with.

Exceptions

Exception Type	Condition
NotImplementedException	The property is called.

Implements:

IDictionary.Item

Notes to inheritors: It is necessary to implement the current property for the derived channel sink to function.

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Keys

Summary

When implemented by a derived class, gets an ICollection of keys that the channel object properties are associated with.

C# Syntax:

public virtual ICollection Keys {get;}

Implements:

IDictionary.Keys

Notes to inheritors: It is necessary to implement the current property for the derived channel sink to function.

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Properties

Summary

Gets an IDictionary of the channel properties associated with the current channel object.

C# Syntax:

public virtual IDictionary Properties {get;}

Channels properties are used to configure the channel at run time.

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.SyncRoot

Summary

Gets an object that is used to synchronize access to the BaseChannelObjectWithProperties.

C# Syntax:

public virtual object SyncRoot {get;}

Implements:

ICollection.SyncRoot

The current implementation of BaseChannelObjectWithProperties.SyncRoot returns a reference to the current instance of BaseChannelObjectWithProperties.

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Values

Summary

Gets an ICollection of the values of the properties associated with the current channel object.

C# Syntax:

public virtual ICollection Values {get;}

Implements:

IDictionary.Values

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Add

Summary

The current method must not be implemented because it does not apply to the way IDictionary is being used in this case, and because BaseChannelObjectWithProperties.IsFixedSize returns true.

C# Syntax:

public virtual void Add(    object key,    object value );

key

Indicates the key associated with the object contained in the value parameter.

value

Indicates the value to add.

Exceptions

Exception Type	Condition
NotSupportedException	The method was called.

Implements:

IDictionary.Add

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Clear

Summary

The current method must not be implemented because it does not apply to the way IDictionary is being used in this case, and because BaseChannelObjectWithProperties.IsFixedSize returns true.

C# Syntax:

public virtual void Clear();

Exceptions

Exception Type	Condition
NotSupportedException	The method was called.

Implements:

IDictionary.Clear

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Contains

Summary

Returns a Boolean value indicating whether the current channel object contains a property associated with the specified key.

C# Syntax:

public virtual bool Contains(    object key );

key

The key the requested property is associated with.

Return Value:

A Boolean value indicating whether the current channel object contains a property associated with the specified key.

Implements:

IDictionary.Contains

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.CopyTo

Summary

The current method is not supported by the BaseChannelObjectWithProperties.

C# Syntax:

public virtual void CopyTo(    Array array,    int index );

array

The array to copy the properties to.

index

The index where to begin copying.

Exceptions

Exception Type	Condition
NotSupportedException	The method was called.

Implements:

ICollection.CopyTo

Return to top

Inherited
See base class member description: System.Object.Equals

C# Syntax:

public virtual bool Equals(    object obj );

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.Finalize

C# Syntax:

~BaseChannelSinkWithProperties();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.GetEnumerator

Summary

Returns an IDictionaryEnumerator that enumerates over all the properties associated with the current channel object.

C# Syntax:

public virtual IDictionaryEnumerator GetEnumerator();

Return Value:

An IDictionaryEnumerator that enumerates over all the properties associated with the current channel object.

Implements:

IDictionary.GetEnumerator

Return to top

Inherited
See base class member description: System.Object.GetHashCode

C# Syntax:

public virtual int GetHashCode();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.GetType

C# Syntax:

public Type GetType();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.MemberwiseClone

C# Syntax:

protected object MemberwiseClone();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Channels.BaseChannelObjectWithProperties.Remove

Summary

The current method must not be implemented because it does not apply to the way IDictionary is being used in this case, and because BaseChannelObjectWithProperties.IsFixedSize returns true.

C# Syntax:

public virtual void Remove(    object key );

key

The key that the object being removed is associated with.

Exceptions

Exception Type	Condition
NotSupportedException	The method was called.

Implements:

IDictionary.Remove

Return to top

Inherited
See base class member description: System.Object.ToString

C# Syntax:

public virtual string ToString();

For more information on members inherited from System.Object click on the link above.

Return to top

Top of page