UrlAttribute Class

UrlAttribute Class

 

Defines an attribute that can be used at the call site to specify the URL where the activation will happen. This class cannot be inherited.

Namespace:   System.Runtime.Remoting.Activation
Assembly:  mscorlib (in mscorlib.dll)

System::Object
  System::Attribute
    System.Runtime.Remoting.Contexts::ContextAttribute
      System.Runtime.Remoting.Activation::UrlAttribute

[SerializableAttribute]
[SecurityCriticalAttribute]
[ComVisibleAttribute(true)]
public ref class UrlAttribute sealed : ContextAttribute

NameDescription
System_CAPS_pubmethodUrlAttribute(String^)

Creates a new instance of the UrlAttribute class.

NameDescription
System_CAPS_pubpropertyName

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the name of the context attribute.(Inherited from ContextAttribute.)

System_CAPS_pubpropertyTypeId

When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)

System_CAPS_pubpropertyUrlValue

Gets the URL value of the UrlAttribute.

NameDescription
System_CAPS_pubmethodEquals(Object^)

Checks whether the specified object refers to the same URL as the current instance.(Overrides ContextAttribute::Equals(Object^).)

System_CAPS_pubmethodFreeze(Context^)

This API supports the product infrastructure and is not intended to be used directly from your code. Called when the context is frozen.(Inherited from ContextAttribute.)

System_CAPS_pubmethodGetHashCode()

Returns the hash value for the current UrlAttribute.(Overrides ContextAttribute::GetHashCode().)

System_CAPS_pubmethodGetPropertiesForNewContext(IConstructionCallMessage^)

Forces the creation of the context and the server object inside the context at the specified URL.(Overrides ContextAttribute::GetPropertiesForNewContext(IConstructionCallMessage^).)

System_CAPS_pubmethodGetType()

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

System_CAPS_pubmethodIsContextOK(Context^, IConstructionCallMessage^)

Returns a Boolean value that indicates whether the specified Context meets UrlAttribute's requirements.(Overrides ContextAttribute::IsContextOK(Context^, IConstructionCallMessage^).)

System_CAPS_pubmethodIsDefaultAttribute()

When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.(Inherited from Attribute.)

System_CAPS_pubmethodIsNewContextOK(Context^)

This API supports the product infrastructure and is not intended to be used directly from your code. Returns a Boolean value indicating whether the context property is compatible with the new context.(Inherited from ContextAttribute.)

System_CAPS_pubmethodMatch(Object^)

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)

System_CAPS_pubmethodToString()

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

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute::GetIDsOfNames(Guid%, IntPtr, UInt32, UInt32, IntPtr)

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute::GetTypeInfo(UInt32, UInt32, IntPtr)

Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute::GetTypeInfoCount(UInt32%)

Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute::Invoke(UInt32, Guid%, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

The UrlAttribute is passed in the activation attributes array as a parameter to Activator::CreateInstance when creating activated objects with the CreateInstance method.

For more information about using attributes, see Extending Metadata Using Attributes.

The following code example illustrates the use of the UrlAttribute in setting up client-activated remoting. The example contains three parts: a client, a server, and a remote object that is used by the client and server.

The following code example shows a client:

#using <System.Runtime.Remoting.dll>
#using <System.dll>
#using "RemoteObject.dll"

using namespace System;
using namespace System::Runtime::Remoting;
using namespace System::Runtime::Remoting::Activation;
using namespace System::Runtime::Remoting::Channels;
using namespace System::Runtime::Remoting::Channels::Tcp;

[STAThread]
int main()
{

   // Report initial status.
   Console::WriteLine( "Client starting." );

   // Register TCP channel.
   ChannelServices::RegisterChannel( gcnew TcpChannel );

   // Create UrlAttribute.
   UrlAttribute^ attribute = gcnew UrlAttribute( "tcp://localhost:1234/RemoteApp" );
   Console::WriteLine( "UrlAttribute value: {0}", attribute->UrlValue );

   array<Object^>^activationAttributes = {attribute};

   // Use UrlAttribute to register for client activated remote object.
   RemotingConfiguration::RegisterActivatedClientType( RemoteObject::typeid, "tcp://localhost:1234/RemoteApp" );

   // Activate remote object.
   Console::WriteLine( "Activating remote object." );
   RemoteObject ^ obj = dynamic_cast<RemoteObject^>(Activator::CreateInstance( RemoteObject::typeid, nullptr, activationAttributes ));

   // Invoke a method on it.
   Console::WriteLine( "Invoking Hello() on remote object." );
   obj->Hello();

   // Inform user of termination.
   Console::WriteLine( "Terminating client." );
}

The following code example shows a server for this client:

#using <System.Runtime.Remoting.dll>
#using <System.dll>
#using "RemoteObject.dll"

using namespace System;
using namespace System::Runtime::Remoting;
using namespace System::Runtime::Remoting::Channels;
using namespace System::Runtime::Remoting::Channels::Tcp;

[STAThread]
int main()
{

   // Report status to user.
   Console::WriteLine( "Server starting." );

   // Register the TCP channel.
   ChannelServices::RegisterChannel( gcnew TcpChannel( 1234 ) );

   // Set application name.
   RemotingConfiguration::ApplicationName = "RemoteApp";

   // Register object for client activated remoting.
   RemotingConfiguration::RegisterActivatedServiceType( RemoteObject::typeid );

   // Wait until termination.
   Console::WriteLine( "Press enter to end." );
   Console::ReadLine();
   Console::WriteLine( "Terminating server." );
}

The following code example shows the remote object that is used by the client and the server:

using namespace System;
using namespace System::Security;
using namespace System::Security::Permissions;

[assembly:AllowPartiallyTrustedCallersAttribute];
public ref class RemoteObject: public MarshalByRefObject
{
public:
   RemoteObject()
   {

      // Report object construction to server's console.
      Console::WriteLine( "You have called the constructor." );
   }

   void Hello()
   {

      // Report method invocation to server's console.
      Console::WriteLine( "You have called Hello()." );
   }

};

.NET Framework
Available since 1.1

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:
© 2016 Microsoft