JRTPLIB  3.11.1
rtpabortdescriptors.h
Go to the documentation of this file.
1 /*
2 
3  This file is a part of JRTPLIB
4  Copyright (c) 1999-2017 Jori Liesenborgs
5 
6  Contact: jori.liesenborgs@gmail.com
7 
8  This library was developed at the Expertise Centre for Digital Media
9  (http://www.edm.uhasselt.be), a research center of the Hasselt University
10  (http://www.uhasselt.be). The library is based upon work done for
11  my thesis at the School for Knowledge Technology (Belgium/The Netherlands).
12 
13  Permission is hereby granted, free of charge, to any person obtaining a
14  copy of this software and associated documentation files (the "Software"),
15  to deal in the Software without restriction, including without limitation
16  the rights to use, copy, modify, merge, publish, distribute, sublicense,
17  and/or sell copies of the Software, and to permit persons to whom the
18  Software is furnished to do so, subject to the following conditions:
19 
20  The above copyright notice and this permission notice shall be included
21  in all copies or substantial portions of the Software.
22 
23  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
24  OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26  THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
29  IN THE SOFTWARE.
30 
31 */
32 
37 #ifndef RTPABORTDESCRIPTORS_H
38 
39 #define RTPABORTDESCRIPTORS_H
40 
41 #include "rtpconfig.h"
42 #include "rtpsocketutil.h"
43 
44 namespace jrtplib
45 {
46 
64 class JRTPLIB_IMPORTEXPORT RTPAbortDescriptors
65 {
66 public:
69 
71  int Init();
72 
75  SocketType GetAbortSocket() const { return m_descriptors[0]; }
76 
78  bool IsInitialized() const { return m_init; }
79 
81  void Destroy();
82 
86  int SendAbortSignal();
87 
90  int ReadSignallingByte();
91 
95  int ClearAbortSignal();
96 private:
97  SocketType m_descriptors[2];
98  bool m_init;
99 };
100 
101 } // end namespace
102 
103 #endif // RTPABORTDESCRIPTORS_H
bool IsInitialized() const
Returns a flag indicating if this instance was initialized.
Definition: rtpabortdescriptors.h:78
SocketType GetAbortSocket() const
Returns the socket descriptor that can be included in a call to 'select' (for example).
Definition: rtpabortdescriptors.h:75
Definition: rtpfaketransmitter.h:64
Helper class for several RTPTransmitter instances, to be able to cancel a call to 'select'...
Definition: rtpabortdescriptors.h:64