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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
/*
* Connection between threads in the same adress space
* $Id$
*
* Created by Jean-Etienne LAMIAUD on Wed May 21 2006
* Copyright (C) 2006-2019 Jean-Etienne Lamiaud
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
/*! \defgroup Support Support classes
* Support classes offer utility features to other classes
*/
/*!
* @header
* @abstract Connection between threads in the same adress space
*/
#ifndef __LYNKEOSTHREADCONNECTION_H
#define __LYNKEOSTHREADCONNECTION_H
#import <Foundation/Foundation.h>
@class LynkeosThreadCnxEnd;
/*!
* @abstract This class implements a connection between threads in the same
* adress space.
* @discussion Contrary to the standard NSConnection, the arguments to
* inter-thread calls are passed by address. This saves time but forbid
* use in inter-process or network messaging.<br>
* The thread which creates the connection is called "main" hereunder, even
* though it can be any thread.
* @ingroup Support
*/
@interface LynkeosThreadConnection : NSObject
{
@private
id _rootObject; //!< Object controlling the connection in the main thread
id _rootProxy; //!< Proxy for the controlling object
LynkeosThreadCnxEnd *_endPoint[2]; //!< Main and thread enpoints
}
/*!
* @abstract Accessor to the port of the "main" end of the connection
* @result The port
*/
- (NSPort*) mainPort;
/*!
* @abstract Accessor to the port of the "thread" end of the connection
* @result The port
*/
- (NSPort*) threadPort;
/*!
* @abstract Check wether some message remains to be processed
* @discussion You do not need to call this before releasing the connection
* as it itself waits for idle state before deallocating.
* @result YES if no message is waiting to be processed
*/
- (BOOL) connectionIdle ;
/*!
* @abstract Creation of a proxy for the object controlling one thread
* @discussion The proxy shall be released (in either thread) before its
* connection is deallocated.
* @param object The controlling object
* @param inThread Selects the created thread if YES
* @result The proxy for the object controlling the requested thread
*/
- (NSProxy*) proxyForObject:(id)object inThread:(BOOL)inThread ;
/*!
* @abstract Set the object controlling the creating thread
* @param anObject The controlling object
*/
- (void)setRootObject:(id)anObject;
/*!
* @abstract Access to the proxy for the object controlling the creating thread
* @discussion This method shall be called at least once from the created thread
* as the first call registers the connection in the thread run loop.
* @result The proxy for the object controlling the creating thread
*/
- (NSProxy*)rootProxy;
/*!
* @abstract Call a selector on an object on the main thread
* @discussion The selector shall take only one argument of type id, or no
* argument at all.<br>
* The LynkeosThreadConnection registered for the current thread will be
* used for sending the request.
* @param sel The selector to perform
* @param target The target object
* @param arg The only argument of the method being called
*/
+ (void) performSelectorOnMainThread:(SEL)sel forObject:(NSObject*)target withArg:(id)arg;
/*!
* @abstract Connection initialization
* @param mainPort The port of the creating thread
* @param threadPort The port for the created thread
* @result The new connection
*/
- (id)initWithMainPort:(NSPort*)mainPort threadPort:(NSPort*)threadPort;
@end
#endif
|
