File: SocketManager.h

package info (click to toggle)
between 6%2Bdfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 3,532 kB
  • sloc: cpp: 28,110; php: 718; ansic: 638; objc: 245; sh: 236; makefile: 97; perl: 67
file content (90 lines) | stat: -rw-r--r-- 1,696 bytes parent folder | download | duplicates (18)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
/*
 * Modification History
 *
 * 2004-December-13   Jason Rohrer
 * Created.
 */



#ifndef SOCKET_MANAGER_INCLUDED
#define SOCKET_MANAGER_INCLUDED



#include "minorGems/network/Socket.h"
#include "minorGems/system/MutexLock.h"
#include "minorGems/util/SimpleVector.h"



/**
 * Ensures proper destruction of static data items at program termination.
 */
class SocketManagerDataWrapper {

    public:

        SocketManagerDataWrapper();
        
        ~SocketManagerDataWrapper();


        MutexLock *mLock;
        SimpleVector<Socket *> *mSocketVector;

    };



/**
 * A class that ensures thread-safe socket shutdown and destruction.
 *
 * Useful if a thread needs to break a socket that another thread is using.
 */
class SocketManager {

    public:


        
        /**
         * Adds a socket to this manager.
         *
         * @param inSocket the socket to add.
         *   Will be destroyed by this manager.
         */
        static void addSocket( Socket *inSocket );

        

        /**
         * Breaks the connection (both directions) associated with a socket.
         *
         * This call is safe even if inSocket has already been destroyed.
         *
         * @param inSocket the socket to break.
         */
        static void breakConnection( Socket *inSocket );


        
        /**
         * Destroys a socket and removes it from this manager.
         *
         * @param inSocket the socket to destroy.
         */
        static void destroySocket( Socket *inSocket );


        
    private:

        // allocated statically to ensure destruction on program termination
        static SocketManagerDataWrapper mDataWrapper;

    };



#endif