Click here to Skip to main content
11,484,162 members (69,215 online)
Click here to Skip to main content
Add your own
alternative version

The Super Pool Framework

, 31 Aug 2010 CPOL 51.1K 1.2K 168
The Super Pool is a framework for decoupled communication and management of components. The Super Pool introduces a natural asynchronous communication environment into your solution that can be fluently spread over different components, threads, processes, or even computers or networks.
Matrix_SuperPool_Standalone.zip
Lib
PowerCollections.dll
Matrix.Framework.SuperPool.Standalone
bin
Debug
Release
Common.Sockets
Common
Core
Matrix.Common.Core
Collections
Identification
Results
Serialization
Matrix.Common.Extended
FastSerialization
Operationals
ThreadPools
Matrix.Common.Sockets
Common
Core
Matrix.Framework.MessageBus
Client
Clients
ExecutionStrategies
Core
Net
Messages
Matrix.Framework.SuperPool
Call
Clients
Core
DynamicProxy
Subscription
Matrix.Framework.SuperPool.Standalone.csproj.user
Properties
Tests
Lib
log4net.dll
Matrix.Common.Core.dll
Matrix.Common.Diagnostics.dll
Matrix.Common.Diagnostics.FrontEnd.dll
Matrix.Common.Extended.dll
Matrix.Common.FrontEnd.dll
Matrix.Common.Sockets.dll
Matrix.Framework.TestFramework.dll
nunit.framework.dll
Matrix.Framework.SuperPool.Demonstration
bin
Debug
Release
FormServer.cs.bak
Properties
Matrix.Framework.SuperPool.Test
bin
Debug
Release
Matrix.Framework.SuperPool.Test.vshost.exe.manifest
MultiThreadTests
Properties
Settings.settings
SpeedTests
Matrix.Framework.SuperPool.UnitTest
bin
Debug
Release
Matrix.Framework.SuperPool.UnitTest.csproj.user
Properties
// -----
// Copyright 2010 Deyan Timnev
// This file is part of the Matrix Platform (www.matrixplatform.com).
// The Matrix Platform is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, 
// either version 3 of the License, or (at your option) any later version. The Matrix Platform is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 
// without even the implied warranty of  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
// You should have received a copy of the GNU Lesser General Public License along with the Matrix Platform. If not, see http://www.gnu.org/licenses/lgpl.html
// -----
using System;
using Matrix.Common.Extended.Operationals;
using Matrix.Framework.MessageBus.Clients.ExecutionStrategies;

namespace Matrix.Framework.MessageBus.Core
{
    /// <summary>
    /// Base interface for client implementations of the message bus client.
    /// </summary>
    public abstract class MessageBusClient : Operational, IDisposable
    {
        public abstract IMessageBus MessageBus { get; }

        public abstract ClientId Id { get; }

        public abstract ExecutionStrategy ExecutionStrategy { get; }

        /// <summary>
        /// The type of the source (optional, may be null in case client is used in standalone mode).
        /// </summary>
        public abstract Type OptionalSourceType { get; }

        public delegate void EnvelopeUpdateDelegate(MessageBusClient stub, Envelope envelope);
        public delegate void ClientUpdateDelegate(MessageBusClient client);

        /// <summary>
        /// *IMPORTANT* this event is executed on an incoming thread from the message bus, and must never be blocked, since it will compomise the model.
        /// This is NOT executed on the new execution thread, use EnvelopeExecuteEvent for this. Process calls on this event as fast as possible.
        /// </summary>
        public event EnvelopeUpdateDelegate EnvelopeReceivedEvent;

        public event EnvelopeUpdateDelegate EnvelopeExecutingEvent;
        public event EnvelopeUpdateDelegate EnvelopeExecutedEvent;

        /// <summary>
        /// General update of some of the properties of the client.
        /// </summary>
        public event ClientUpdateDelegate UpdateEvent;

        /// <summary>
        /// Constructor.
        /// </summary>
        public MessageBusClient()
        {
        }

        /// <summary>
        /// Dispose of any associations or resources.
        /// Will also free any of the events, although it 
        /// is any subscriber responcibility to release the events as well.
        /// </summary>
        public virtual void Dispose()
        {
            EnvelopeReceivedEvent = null;
            EnvelopeExecutingEvent = null;
            EnvelopeExecutedEvent = null;
            UpdateEvent = null;
        }

        internal abstract bool Receive(Envelope envelope);

        internal abstract bool AssignMessageBus(IMessageBus messageBus, int indexId);

        internal abstract void ReleaseMessageBus();

        public abstract bool SetupExecutionStrategy(ExecutionStrategy executionStrategy);
        
        protected void RaiseEnvelopeReceivedEvent(Envelope envelope)
        {
            EnvelopeUpdateDelegate envelopeReceivedDelegate = EnvelopeReceivedEvent;
            if (envelopeReceivedDelegate != null)
            {
                envelopeReceivedDelegate(this, envelope);
            }
        }

        protected void RaiseEnvelopeExecutingEvent(Envelope envelope)
        {
            EnvelopeUpdateDelegate envelopeReceivedDelegate = EnvelopeExecutingEvent;
            if (envelopeReceivedDelegate != null)
            {
                envelopeReceivedDelegate(this, envelope);
            }
        }

        protected void RaiseEnvelopeExecutedEvent(Envelope envelope)
        {
            EnvelopeUpdateDelegate envelopeReceivedDelegate = EnvelopeExecutedEvent;
            if (envelopeReceivedDelegate != null)
            {
                envelopeReceivedDelegate(this, envelope);
            }
        }

        /// <summary>
        /// Notify all interested parties, that the client has undergone some update.
        /// </summary>
        public void RaiseUpdateEvent()
        {
            ClientUpdateDelegate del = UpdateEvent;
            if (del != null)
            {
                del(this);
            }
        }
    }
}

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

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

Share

About the Author

Deyan Timnev
Product Manager Ingenious Ltd, Bulgaria
Bulgaria Bulgaria
I worked for a few years as a C++/Win32 developer and software architect, and then moved on to the .NET environment where I was able to discover the beauty of managed programming.

I am currently involved in the development and management of Open Forex Platform (www.openforexplatform.com) and the Matrix Platform (www.matrixplatform.com).

| Advertise | Privacy | Terms of Use | Mobile
Web04 | 2.8.150520.1 | Last Updated 31 Aug 2010
Article Copyright 2010 by Deyan Timnev
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid