System.Runtime.Remoting.WellKnownClientTypeEntry Class

Assembly: Mscorlib.dll
Namespace: System.Runtime.Remoting
Summary
Holds values for an object type registered on the client as a well-known type object (single call or singleton).
C# Syntax:
public class WellKnownClientTypeEntry : TypeEntry
Remarks
Well-known object types can be either single call or singleton. If an object type is single call, a new instance of it is created each time a call from the client comes in. All calls to a singleton object are handled by one instance of that object.

Any client that knows the URI of a registered well-known object can obtain a proxy for this object by registering the channel it prefers with ChannelServices and activating the object by calling new or Activator.GetObject. To activate a well-known object with new, you must first register the well-known object type on the client using the method RemotingConfiguration.RegisterWellKnownClientType. By calling the RemotingConfiguration.RegisterWellKnownClientType method, you are giving the remoting infrastructure the location of the remote object, which allows the new keyword to create it. If, on the other hand, you use the Activator.GetObject method to activate the well-known object, you must supply it with the object's URL as an argument, so no prior registration on the client end is necessary.

For a detailed description of well-known objects and remote object activation see the conceptual topic at MSDN: activation.

See also:
System.Runtime.Remoting Namespace | RemotingConfiguration.RegisterWellKnownClientType | MSDN: serveractivation

System.Runtime.Remoting.WellKnownClientTypeEntry Member List:

Public Constructors
ctor #1 Overloaded:
.ctor(Type type, string objectUrl)

Initializes a new instance of the WellKnownClientTypeEntry class with the given Type and object URL.
ctor #2 Overloaded:
.ctor(string typeName, string assemblyName, string objectUrl)

Initializes a new instance of the WellKnownClientTypeEntry class with the given type, assembly name, and object URL.
Public Properties
ApplicationUrl Read-write

Gets or sets the URL of the application to activate the type in.
AssemblyName
(inherited from System.Runtime.Remoting.TypeEntry)
Read-write

See base class member description: System.Runtime.Remoting.TypeEntry.AssemblyName


Gets the assembly name of the object type configured to be a remote activated type.
ObjectType Read-only

Gets the Type of the well-known client type.
ObjectUrl Read-only

Gets the URL of the well-known client object.
TypeName
(inherited from System.Runtime.Remoting.TypeEntry)
Read-write

See base class member description: System.Runtime.Remoting.TypeEntry.TypeName


Gets the full type name of the object type configured to be a remote activated type.
Public Methods
Equals
(inherited from System.Object)
See base class member description: System.Object.Equals

Derived from System.Object, the primary base class for all objects.
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.
ToString Overridden:
Returns the full type name, assembly name, and object URL of the well-known client type as a String.
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.Runtime.Remoting.WellKnownClientTypeEntry Member Details

Overloaded ctor #1
Summary
Initializes a new instance of the WellKnownClientTypeEntry class with the given Type and object URL.
C# Syntax:
public WellKnownClientTypeEntry(
   Type type,
   string objectUrl
);
Parameters:

type

The Type of the well-known client type.

objectUrl

The URL of the well-known object type.

Return to top


Overloaded ctor #2
Summary
Initializes a new instance of the WellKnownClientTypeEntry class with the given type, assembly name, and object URL.
C# Syntax:
public WellKnownClientTypeEntry(
   string typeName,
   string assemblyName,
   string objectUrl
);
Parameters:

typeName

The type name of the well-known client type.

assemblyName

The assembly name of the well-known client type.

objectUrl

The URL of the well-known object type.

Return to top


Property: ApplicationUrl (read-write)
Summary
Gets or sets the URL of the application to activate the type in.
C# Syntax:
public string ApplicationUrl {get; set;}
Remarks
The application URL is optional and should be set to the URL of the application corresponding to the well-known object.

Return to top


Property: AssemblyName (read-write)
Inherited
See base class member description: System.Runtime.Remoting.TypeEntry.AssemblyName

Summary
Gets the assembly name of the object type configured to be a remote activated type.
C# Syntax:
public string AssemblyName {get; set;}

Return to top


Property: ObjectType (read-only)
Summary
Gets the Type of the well-known client type.
C# Syntax:
public Type ObjectType {get;}

Return to top


Property: ObjectUrl (read-only)
Summary
Gets the URL of the well-known client object.
C# Syntax:
public string ObjectUrl {get;}

Return to top


Property: TypeName (read-write)
Inherited
See base class member description: System.Runtime.Remoting.TypeEntry.TypeName

Summary
Gets the full type name of the object type configured to be a remote activated type.
C# Syntax:
public string TypeName {get; set;}

Return to top


Method: Equals(
   object obj
)
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


Method: Finalize()
Inherited
See base class member description: System.Object.Finalize
C# Syntax:
~WellKnownClientTypeEntry();

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

Return to top


Method: GetHashCode()
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


Method: GetType()
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


Method: MemberwiseClone()
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


Overridden Method: ToString()
Summary
Returns the full type name, assembly name, and object URL of the well-known client type as a String.
C# Syntax:
public override string ToString();
Return Value:
The full type name, assembly name, and object URL of the well-known client type as a String.
Remarks
If WellKnownClientTypeEntry.ApplicationUrl is not null, it is returned at the end of the string.

Return to top


Top of page

Copyright (c) 2002 Microsoft Corporation. All rights reserved.