Multicast Delegates in CSharp

الـ Delegate هو (Type-Safe Function Pointer). ده معناه إن الـ delegate بيبقا جواه reference لـ method أو function ولما بنستدعي الـ delegate، الـ method اللي بيشاور ليها بتتنفذ.

الـ delegate signature والـ method اللي بيشاور عليها لازم يكون ليهم نفس الـ signature.

فيه نوعين من الـ Delegates في C#:

• الـ Single Cast Delegate: الـ Delegate بيشير لـ function أو method واحدة بس.
• الـ Multicast Delegate: الـ Delegate بيشير لأكتر من function أو method.

اتكلمنا بالفعل عن Singlecast Delegate. النهارده، هنتكلم عن Multicast Delegates.

What is Multicast Delegate in C#?

الـ Multicast Delegate في C# هو delegate بيحمل references لأكتر من handler function واحدة. لما بنستدعي multicast delegate، كل الـ functions اللي الـ delegate بيشير ليها بتتنفذ. لو عايز تستدعي أكتر من method باستخدام delegate، يبقى كل الـ method signatures لازم تكون زي بعض.

فـ multicast delegate هو مجرد (array) من أكتر من pipeline أو أكتر من delegate. الـ Delegates بتتنفذ بنفس الترتيب اللي اتحطت بيه في الـ invocation list. الـ InvocationList هو ببساطة Array من delegates أو pipelines كل pipeline فيها بينقل البيانات لـ method مختلفة.

Example to Understand Multicast Delegate in C#

من غير delegates.

using System;
namespace MulticastDelegateDemo
{
    public class Rectangle
    {
        public void GetArea(double Width, double Height)
        {
            Console.WriteLine($"Area is {Width * Height}");
        }
        public void GetPerimeter(double Width, double Height)
        {
            Console.WriteLine($"Perimeter is {2 * (Width + Height)}");
        }
        static void Main(string[] args)
        {
            Rectangle rect = new Rectangle();
            rect.GetArea(23.45, 67.89);
            rect.GetPerimeter(23.45, 67.89);
            Console.ReadKey();
        }
    }
}

Output:

Area is 1592.1205
Perimeter is 182.68

في المثال اللي فوق، عملنا instance من Rectangle class وبعدين استدعينا الاتنين methods. دلوقتي أنا عايز أعمل delegate واحد يستدعي الاتنين methods اللي فوق دول. الاتنين methods ليهم نفس الـ signature بأسماء مختلفة، فنقدر نعمل delegate واحد يحمل الـ reference بتاع الاتنين methods. ولما نستدعي الـ delegate، هيستدعي الاتنين methods. وده اللي بيتسمى Multicast Delegate.

Multicast Delegate Example in C#

using System;
namespace MulticastDelegateDemo
{
    public delegate void RectangleDelegate(double Width, double Height);
    public class Rectangle
    {
        public void GetArea(double Width, double Height) { /* ... */ }
        public void GetPerimeter(double Width, double Height) { /* ... */ }
 
        static void Main(string[] args)
        {
            Rectangle rect = new Rectangle();
            RectangleDelegate rectDelegate = new RectangleDelegate(rect.GetArea);
 
            // Use += operator to chain delegates together.
            rectDelegate += rect.GetPerimeter;
 
            Delegate[] InvocationList = rectDelegate.GetInvocationList();
            Console.WriteLine("InvocationList:");
            foreach (var item in InvocationList)
            {
                Console.WriteLine($"  {item}");
            }
            Console.WriteLine();
            Console.WriteLine("Invoking Multicast Delegate:");
            rectDelegate(23.45, 67.89);
 
            Console.WriteLine();
            Console.WriteLine("Invoking Multicast Delegate After Removing one Pipeline:");
            // Removing a method from delegate object
            rectDelegate -= rect.GetPerimeter;
            rectDelegate.Invoke(13.45, 76.89);
 
            Console.ReadKey();
        }
    }
}

Output:

InvocationList:
  MulticastDelegateDemo.RectangleDelegate
  MulticastDelegateDemo.RectangleDelegate

Invoking Multicast Delegate:
Area is 1592.1205
Perimeter is 182.68

Invoking Multicast Delegate After Removing one Pipeline:
Area is 1034.1205

في المثال اللي فوق، عملنا delegate واحد الـ signature بتاعه هو هو نفس بتاع الاتنين methods GetArea , GetPerimeter.

بعدين عملنا instance من delegate وربطنا الاتنين methods باستخدام += operator.

بنفس الطريقة، تقدر تستخدم -= operator عشان تشيل function من الـ delegate.

بمجرد ما بنربط الاتنين methods بالـ delegate instance ولما بنستدعي الـ delegate، الاتنين methods بيتنفذوا.

Another Approach to Creating Multicast Delegates in C#

using System;
namespace MulticastDelegateDemo
{
    public delegate void MathDelegate(int No1, int No2);
    public class Program
    {
        // Static Methods
        public static void Add(int x, int y) { /*...*/ }
        public static void Sub(int x, int y) { /*...*/ }
        
        // Non-Static Methods
        public void Mul(int x, int y) { /*...*/ }
        public void Div(int x, int y) { /*...*/ }
 
        static void Main(string[] args)
        {
            Program p = new Program();
            MathDelegate del1 = new MathDelegate(Add);
            MathDelegate del2 = new MathDelegate(Program.Sub);
            MathDelegate del3 = new MathDelegate(p.Mul); 
            MathDelegate del4 = new MathDelegate(p.Div);
 
            // Use + operator to chain delegates together
            MathDelegate del5 = del1 + del2 + del3 + del4;
 
            Console.WriteLine("Invoking Multicast Delegate::");
            del5.Invoke(20, 5);
 
            Console.WriteLine();
            Console.WriteLine("Invoking Multicast Delegate After Removing one Delegate:");
            del5 -= del2;
            del5(22, 7);
            
            Console.ReadKey();
        }
    }
}

هنا استخدمنا static و non-static methods. عملنا أربعة instances من الـ delegate وربطنا الأربع methods. في الآخر، عملنا delegate instance خامس وربطنا بيه كل الأربع delegate instances باستخدام + operator. دلوقتي، الـ delegate الخامس بقى multicast delegate.

Multicast Delegates with Return Type in C#

الـ multicast delegate بيستدعي الـ methods بنفس الترتيب اللي اتضافت بيه. لحد دلوقتي، الأمثلة اللي ناقشناها مكانتش بترجع أي حاجة (void). إيه اللي بيحصل لو الـ delegate ليه return type؟

لو الـ delegate ليه return type غير void، ولو الـ delegate ده multicast delegate، يبقى بس قيمة آخر method تم استدعاؤها هي اللي هترجع.

بنفس المنطق، لو الـ delegate ليه out parameter، فقيمة الـ output parameter هتكون القيمة اللي خصصتها آخر method تم استدعاؤها من الـ Invocation List.

Example to Understand Multicast Delegates with Return Type

using System;
namespace MulticastDelegateDemo
{
    // Delegate's return type is int
    public delegate int SampleDelegate();
    public class Program
    {
        static void Main()
        {
            SampleDelegate del = new SampleDelegate(MethodOne);
            del += MethodTwo;
            
            // The value returned will be 2, from MethodTwo()
            int ValueReturnedByDelegate = del();
            Console.WriteLine($"Returned Value = {ValueReturnedByDelegate}");
            Console.ReadKey();
        }
        public static int MethodOne()
        {
            Console.WriteLine("MethodOne is Executed");
            return 1;
        }
        public static int MethodTwo()
        {
            Console.WriteLine("MethodTwo is Executed");
            return 2;
        }
    }
}

Output:

MethodOne is Executed
MethodTwo is Executed
Returned Value = 2

Example to Understand Multicast Delegates using out Parameter in C#

using System;
namespace MulticastDelegateDemo
{
    // Delegate has an int output parameter
    public delegate void SampleDelegate(out int Integer);
    public class Program
    {
        static void Main()
        {
            SampleDelegate del = new SampleDelegate(MethodOne);
            del += MethodTwo;
            
            // The value of ValueFromOutPutParameter will be 2
            int ValueFromOutPutParameter = -1;
            del(out ValueFromOutPutParameter);
            Console.WriteLine($"Returned Value = {ValueFromOutPutParameter}");
            Console.ReadKey();
        }
        public static void MethodOne(out int Number)
        {
            Console.WriteLine("MethodOne is Executed");
            Number = 1;
        }
        public static void MethodTwo(out int Number)
        {
            Console.WriteLine("MethodTwo is Executed");
            Number = 2;
        }
    }
}

Output:

MethodOne is Executed
MethodTwo is Executed
Returned Value = 2