S K UCI / NetServicesMin

Fork of NetServicesMin with some warnings removed

Dependencies:   lwip-sys lwip

Fork of NetServicesMin by Hendrik Lipka

core/netservice.h@0:8b387bed54c2, 2011-01-10 (annotated)

Committer:
hlipka
Date:
Mon Jan 10 21:03:11 2011 +0000
Revision:
0:8b387bed54c2
initial version

Who changed what in which revision?

UserRevisionLine numberNew contents of line
hlipka 0:8b387bed54c2 1
hlipka 0:8b387bed54c2 2 /*
hlipka 0:8b387bed54c2 3 Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
hlipka 0:8b387bed54c2 4
hlipka 0:8b387bed54c2 5 Permission is hereby granted, free of charge, to any person obtaining a copy
hlipka 0:8b387bed54c2 6 of this software and associated documentation files (the "Software"), to deal
hlipka 0:8b387bed54c2 7 in the Software without restriction, including without limitation the rights
hlipka 0:8b387bed54c2 8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
hlipka 0:8b387bed54c2 9 copies of the Software, and to permit persons to whom the Software is
hlipka 0:8b387bed54c2 10 furnished to do so, subject to the following conditions:
hlipka 0:8b387bed54c2 11
hlipka 0:8b387bed54c2 12 The above copyright notice and this permission notice shall be included in
hlipka 0:8b387bed54c2 13 all copies or substantial portions of the Software.
hlipka 0:8b387bed54c2 14
hlipka 0:8b387bed54c2 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
hlipka 0:8b387bed54c2 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
hlipka 0:8b387bed54c2 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
hlipka 0:8b387bed54c2 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
hlipka 0:8b387bed54c2 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
hlipka 0:8b387bed54c2 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
hlipka 0:8b387bed54c2 21 THE SOFTWARE.
hlipka 0:8b387bed54c2 22 */
hlipka 0:8b387bed54c2 23
hlipka 0:8b387bed54c2 24 /**
hlipka 0:8b387bed54c2 25 \file Net Service base class header file
hlipka 0:8b387bed54c2 26 */
hlipka 0:8b387bed54c2 27
hlipka 0:8b387bed54c2 28 #ifndef NETSERVICE_H
hlipka 0:8b387bed54c2 29 #define NETSERVICE_H
hlipka 0:8b387bed54c2 30
hlipka 0:8b387bed54c2 31 #include <list>
hlipka 0:8b387bed54c2 32 using std::list;
hlipka 0:8b387bed54c2 33
hlipka 0:8b387bed54c2 34 ///Net Service base class
hlipka 0:8b387bed54c2 35 /**
hlipka 0:8b387bed54c2 36 Each connection-oriented object can register as service (by inheriting this class), so that it is polled regularly.
hlipka 0:8b387bed54c2 37 It notifies the pool when the connection is terminated so that it can be destroyed.
hlipka 0:8b387bed54c2 38 */
hlipka 0:8b387bed54c2 39 class NetService
hlipka 0:8b387bed54c2 40 {
hlipka 0:8b387bed54c2 41 public:
hlipka 0:8b387bed54c2 42 ///Instantiates a new service
hlipka 0:8b387bed54c2 43 /**
hlipka 0:8b387bed54c2 44 @param owned If true the object is owned by the pool and will be destroyed on closure.
hlipka 0:8b387bed54c2 45 */
hlipka 0:8b387bed54c2 46 NetService(bool owned = true); //Is owned by the pool?
hlipka 0:8b387bed54c2 47 virtual ~NetService();
hlipka 0:8b387bed54c2 48
hlipka 0:8b387bed54c2 49 ///This method can be inherited so that it is called on each @a Net::poll() call.
hlipka 0:8b387bed54c2 50 virtual void poll();
hlipka 0:8b387bed54c2 51
hlipka 0:8b387bed54c2 52 static void servicesPoll(); //Poll all registered services & destroy closed ones
hlipka 0:8b387bed54c2 53
hlipka 0:8b387bed54c2 54 protected:
hlipka 0:8b387bed54c2 55 ///This flags the service as to be destructed if owned by the pool.
hlipka 0:8b387bed54c2 56 void close();
hlipka 0:8b387bed54c2 57
hlipka 0:8b387bed54c2 58 private:
hlipka 0:8b387bed54c2 59 bool m_closed;
hlipka 0:8b387bed54c2 60 bool m_removed;
hlipka 0:8b387bed54c2 61 bool m_owned;
hlipka 0:8b387bed54c2 62
hlipka 0:8b387bed54c2 63 static list<NetService*>& lpServices(); //Helper to prevent static initialization fiasco
hlipka 0:8b387bed54c2 64
hlipka 0:8b387bed54c2 65 };
hlipka 0:8b387bed54c2 66
hlipka 0:8b387bed54c2 67 #endif