Michael Spencer / Mbed 2 deprecated LaOS

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

NetServices/core/netservice.h@1:f5ac63519541, 2014-03-05 (annotated)

Committer:
Michael J. Spencer
Date:
Wed Mar 05 06:14:02 2014 -0800
Revision:
1:f5ac63519541
Initial commit.

Who changed what in which revision?

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