Click here to Skip to main content
Click here to Skip to main content

A Remoting Event (Simple and Efficient for Enterprise Solutions)

, 21 Aug 2006
Rate this:
Please Sign up or sign in to vote.
This article contains the simplest solutions for: the security problem for DelegateSerializationHolder, the IO problem, and the messaging speed problem. Note: Messaging speed problem will appear when your application has worked for a long time.

demo project Image

Background

I always had an interest in socket programming. I have created several chat applications and complex socket based applications. When I learned about events in Remoting I was so glad, and the first thing that I thought about was creating a chat application. But in the test, I met with some problems.

Problem 1

The first problem was a security exception:

System.Security.SecurityException: Type System.DelegateSerializationHolder 
and the types derived from it (such as System.DelegateSerializationHolder) 
are not permitted to be deserialized at this security level.

Security Exception Image

Solution 1

This problem was solved by adding the typeFilterLevel attribute with Full value to the formatter element of both configuration files.

<formatter ref="soap" typeFilterLevel="Full" />

Problem 2

But again, it did not work and an IO exception occurred:

System.Reflection.TargetInvocationException: 
Exception has been thrown by the target of an invocation. ---> 
System.IO.FileNotFoundException: Could not load file or assembly 
'Client, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null' 
or one of its dependencies. The system cannot find the file specified.

This exception occurs while the request is deserialized at the server. The server tries to call the event handler whereas the event handler exists in the client assembly. Because the client assembly is not available at the server, the exception is thrown.

IO exception Image

Solution 2

An intermediate wrapper class, MarshalByRefObject will solve this problem. This wrapper class is located in the shared assembly, accessible for both the client and the server; therefore, a delegate can resolve the method's signature. In the client application, we will associate the shared object event with the WrapperMessageReceivedHandler method of the wrapper class and associate an event handler on the client with the MessageReceived event of the wrapper class.

Sequense of events Image

Why [OneWay] Attribute

Without defining the remote method as [OneWay], an exception will occur when the client is unreachable or has been disconnected without disassociating the event handler. By using [OneWay], no exception will occur on the client, but it will be in the invocation list of the server and, in longtime, will make your server slower to respond.

Solution 3

Instead of using the normal event invocation mechanism, you must invoke each delegate on your own, and if an exception occurs, you must disassociate the delegate from the invocation list of the event. In the end, you can remove the [OneWay] attribute.

Shared Class

/// <span class="code-SummaryComment"><summary></span>
/// Represents the method that will handle
/// the Remotable.RemoteClass.MessageReceived event.
/// <span class="code-SummaryComment"></summary></span>
/// <span class="code-SummaryComment"><param name="message">Received message</param></span>

[Serializable]
public delegate void MessageHandler(string message);

/// <span class="code-SummaryComment"><summary></span>
/// Shared remoting class that orchestrate messaging tasks 
/// <span class="code-SummaryComment"></summary></span>

public class RemoteClass:MarshalByRefObject
{

    /// <span class="code-SummaryComment"><summary></span>
    /// Occurs when a broadcast message received.
    /// <span class="code-SummaryComment"></summary></span>

    public event MessageHandler MessageReceived;
    /// <span class="code-SummaryComment"><summary></span>
    /// Initializes a new instance of the Remotable.RemoteClass class.
    /// <span class="code-SummaryComment"></summary></span>

    public RemoteClass()
    {
       
    }

    /// <span class="code-SummaryComment"><summary></span>
    /// Obtains a lifetime service object to control the lifetime policy for this
    /// instance.
    /// <span class="code-SummaryComment"></summary></span>
    /// <span class="code-SummaryComment"><returns></span>
    ///An object of type 
    ///System.Runtime.Remoting.Lifetime.ILease used to control
    ///the lifetime policy for this instance. This is the current lifetime service
    ///object for this instance if one exists; otherwise, a new lifetime service
    ///object initialized to the value of the 
    ///System.Runtime.Remoting.Lifetime.LifetimeServices.LeaseManagerPollTime
    ///property.
    ///null value means this object has to live forever.
    /// <span class="code-SummaryComment"></returns></span>

    public override object InitializeLifetimeService()
    {
        return null;
    }

    /// <span class="code-SummaryComment"><summary></span>
    /// Broadcast message to all clients
    /// <span class="code-SummaryComment"></summary></span>
    /// <span class="code-SummaryComment"><param name="message">message string</param></span>

    public void Send(string message)
    {
        if (MessageReceived != null)
        {
            MessageHandler messageDelegate = null;
            Delegate[] invocationList_ = null;
            try
            {
                invocationList_ = MessageReceived.GetInvocationList();
            }
            catch (MemberAccessException ex)
            {
                throw ex;
            }
            if (invocationList_ != null)
            {
                lock (this)
                {
                    foreach (Delegate del in invocationList_)
                    {
                        try
                        {
                            messageDelegate = (MessageHandler)del;
                            messageDelegate(message);
                        }
                        catch (Exception e)
                        {
                            MessageReceived -= messageDelegate;
                        }
                    }
                }
            }
        }
    }

Client Application

RemoteClass remoteClass;
WrapperClass wrapperClass;

private void Form1_Load(object sender, EventArgs e)
{
    //Configure remoting.

    RemotingConfiguration.Configure(Application.StartupPath + 
                          "\\Client.exe.config",false);

    // Create a proxy from remote object.

    remoteClass = (RemoteClass)Activator.GetObject(typeof(RemoteClass), 
                   "http://localhost:8080/Chat");
    //Create an instance of wrapper class.

    wrapperClass = new WrapperClass();
  
    //Associate remote object event with wrapper method.

    remoteClass.MessageReceived += new 
          MessageHandler(wrapperClass.WrapperMessageReceivedHandler);
    //Associate wrapper event with current form event handler.

    wrapperClass.WrapperMessageReceived += new 
           MessageHandler(MessageReceivedHandler);
}

Wrapper Class

/// <span class="code-SummaryComment"><summary></span>
/// Occurs when a broadcast message received.
/// <span class="code-SummaryComment"></summary></span>

public event MessageHandler WrapperMessageReceived;
/// <span class="code-SummaryComment"><summary></span>
/// Wrapper method for sending message to the clients.
/// <span class="code-SummaryComment"></summary></span>
/// <span class="code-SummaryComment"><param name="sender">Caller object</param></span>
/// <span class="code-SummaryComment"><param name="args">Message data</param></span>

public void WrapperMessageReceivedHandler(string message)
{
    // forward the message to the client

    if(WrapperMessageReceived != null)
        WrapperMessageReceived(message);
}

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

About the Author

Hossein Ghahvei Araghi
Program Manager System Group
Iran (Islamic Republic Of) Iran (Islamic Republic Of)
Hossein Ghahvei Araghi
Birth date: 1978
Birth place: Iran
Academic Credentials : BS(Tehran University)
Microsoft Credentials : MCP, MCAD, MCTS 2.0, MCTS 3.5, MCPD 2.0, MCPD 3.5
Follow on   Twitter   Google+

Comments and Discussions

 
GeneralRe: Missing the point PinmemberHossein eraghi16-Aug-06 0:33 
GeneralRe: Missing the point PinmemberAlex_119-Aug-06 21:24 
GeneralRe: It's just for you PinmemberHossein eraghi21-Aug-06 1:00 
GeneralStill Missing the Point PinmemberAlex_123-Aug-06 0:00 
GeneralInstructive points PinmemberHossein eraghi23-Aug-06 20:04 
GeneralRe: Instructive points PinmemberAlex_123-Aug-06 23:54 
GeneralAbout arrogance and professionalism PinmemberKfir.C12-Sep-07 1:41 
QuestionWas anyone successful making work in v1.1 PinmemberBubba Ole10-Aug-06 5:50 
Cry | :(( Is there a way to modify this code to make it work under v1.1?

 
FreightTrain
AnswerRe: Was anyone successful making work in v1.1 PinmemberHossein eraghi11-Aug-06 19:47 
AnswerRe: Was anyone successful making work in v1.1 Pinmembermihir250812-May-08 13:04 
GeneralGood PinmemberObaid ur Rehman8-Aug-06 7:10 
GeneralRe: Good PinmemberHossein eraghi8-Aug-06 21:44 
GeneralSingleton versus SingleCall mode PinmemberHenk van der Geld8-Aug-06 0:26 
AnswerRe: Singleton versus SingleCall mode PinmemberObaid ur Rehman8-Aug-06 7:04 
GeneralTo make it even better... Pinmembermav.northwind6-Aug-06 20:38 
GeneralRe: To make it even better... PinmemberHossein eraghi6-Aug-06 21:10 
GeneralRe: To make it even better... Pinmembermav.northwind6-Aug-06 23:35 
GeneralRe: To make it even better... PinmemberHossein eraghi6-Aug-06 23:55 
GeneralRe: To make it even better... Pinmembermav.northwind7-Aug-06 6:39 
GeneralRe: To make it even better... PinmemberHossein eraghi7-Aug-06 0:34 
GeneralCool :) Pinmemberleppie6-Aug-06 8:26 
GeneralRe: Cool :) PinmemberHossein eraghi11-Aug-06 20:06 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web03 | 2.8.140709.1 | Last Updated 21 Aug 2006
Article Copyright 2006 by Hossein Ghahvei Araghi
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid