NET_SocketGroup.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        NET_SocketGroup.h
 *
 * COMMENTS:
 *
 *
 */

#ifndef __NET_SOCKETGROUP_H__
#define __NET_SOCKETGROUP_H__

#include "NET_API.h"

#include <UT/UT_NonCopyable.h>
#include <UT/UT_SharedPtr.h>
#include <UT/UT_Signal.h>
#include <UT/UT_StringHolder.h>

/// Interface for grouping sockets together. Typical use case is for web servers
/// where theres a group of server listener sockets.
class NET_API NET_ISocketGroup
{
public:
    virtual ~NET_ISocketGroup();

    UT_NON_COPYABLE(NET_ISocketGroup)

    /// The id of the socket group.
    const UT_StringHolder& name() const { return myName; }

    /// @brief Request that the server shutdown immediatelly and all connections
    /// be closed regardless if the connection has things to process.
    virtual void requestFullShutdown() = 0;
    /// @brief Request the server shutdown slowly and allow all connections
    /// to be closed after they have processed whatever it is they need to.
    virtual void requestGracefulShutdown() = 0;

protected:
    using creator_group_t
            = UT_SharedPtr<NET_ISocketGroup> (*)(const UT_StringHolder&);

    NET_ISocketGroup(const UT_StringHolder& name);

    static UT_SharedPtr<NET_ISocketGroup> newSocketGroup(
            const UT_StringHolder& name,
            creator_group_t creator);
    static UT_SharedPtr<NET_ISocketGroup> findSocketGroup(
            const UT_StringRef& name);
    static void shutdownAll();

    virtual void handleExit(const UT_SharedPtr<NET_ISocketGroup>& me) {}

private:
    friend class net_SocketGroupRegistry;
    friend class NET_SubSystem;

    static void handleExit();

    UT_StringHolder myName;
};

#endif // __NET_SOCKETGROUP_H__