5 // Created by Jens Alfke on 5/10/08.
6 // Copyright 2008 Jens Alfke. All rights reserved.
8 #import "TCPEndpoint.h"
9 @class TCPConnection, IPAddress;
10 @protocol TCPListenerDelegate;
13 /** Generic TCP-based server that listens for incoming connections on a port.
15 For each incoming connection, it creates an instance of (a subclass of) the generic TCP
16 client class TCPClient. The -connectionClass property lets you customize which subclass
19 TCPListener supports SSL, Bonjour advertisements for the service, and automatic port renumbering
20 if there are conflicts. (The SSL related methods are inherited from TCPEndpoint.)
22 You will almost always need to implement the TCPListenerDelegate protocol in your own
23 code, and set an instance as the listener's delegate property, in order to be informed
24 of important events such as incoming connections. */
25 @interface TCPListener : TCPEndpoint
29 BOOL _pickAvailablePort;
31 CFSocketRef _ipv4socket;
32 CFSocketRef _ipv6socket;
34 NSString *_bonjourServiceType, *_bonjourServiceName;
35 NSNetService *_netService;
36 NSDictionary *_bonjourTXTRecord;
37 BOOL _bonjourPublished;
38 NSInteger /*NSNetServicesError*/ _bonjourError;
40 Class _connectionClass;
43 /** Initializes a new TCPListener that will listen on the given port when opened. */
44 - (id) initWithPort: (UInt16)port;
46 /** The subclass of TCPConnection that will be instantiated. */
47 @property Class connectionClass;
49 /** Delegate object that will be called when interesting things happen to the listener --
50 most importantly, when a new incoming connection is accepted. */
51 @property (assign) id<TCPListenerDelegate> delegate;
53 /** Should the server listen for IPv6 connections (on the same port number)? Defaults to NO. */
54 @property BOOL useIPv6;
56 /** The port number to listen on.
57 If the pickAvailablePort property is enabled, this value may be updated after the server opens
58 to reflect the actual port number being used. */
59 @property uint16_t port;
61 /** Should the server pick a higher port number if the desired port is already in use?
62 Defaults to NO. If enabled, the port number will be incremented until a free port is found. */
63 @property BOOL pickAvailablePort;
65 /** Opens the server. You must call this after configuring all desired properties (property
66 changes are ignored while the server is open.) */
67 - (BOOL) open: (NSError **)error;
69 /** Opens the server, without returning a specific error code.
70 (In case of error the delegate's -listener:failedToOpen: method will be called with the
71 error code, anyway.) */
74 /** Closes the server. */
77 /** Is the server currently open? */
78 @property (readonly) BOOL isOpen;
83 /** The Bonjour service type to advertise. Defaults to nil; setting it implicitly enables Bonjour.
84 The value should look like e.g. "_http._tcp."; for details, see the NSNetService documentation. */
85 @property (copy) NSString *bonjourServiceType;
87 /** The Bonjour service name to advertise. Defaults to nil, meaning that a default name will be
88 automatically generated if Bonjour is enabled (by setting -bonjourServiceType). */
89 @property (copy) NSString *bonjourServiceName;
91 /** The dictionary form of the Bonjour TXT record: metadata about the service that can be browsed
92 by peers. Changes to this dictionary will be pushed in near-real-time to interested peers. */
93 @property (copy) NSDictionary *bonjourTXTRecord;
95 /** Is this service currently published/advertised via Bonjour? */
96 @property (readonly) BOOL bonjourPublished;
98 /** Current error status of Bonjour service advertising. See NSNetServicesError for error codes. */
99 @property (readonly) NSInteger /*NSNetServicesError*/ bonjourError;
108 /** The delegate messages sent by TCPListener.
109 All are optional except -listener:didAcceptConnection:. */
110 @protocol TCPListenerDelegate <NSObject>
112 /** Called after an incoming connection arrives and is opened;
113 the connection is now ready to send and receive data.
114 To control whether or not a connection should be accepted, implement the
115 -listener:shouldAcceptConnectionFrom: method.
116 To use a different class than TCPConnection, set the listener's -connectionClass property.
117 (This is the only required delegate method; the others are optional to implement.) */
118 - (void) listener: (TCPListener*)listener didAcceptConnection: (TCPConnection*)connection;
121 /** Called after the listener successfully opens. */
122 - (void) listenerDidOpen: (TCPListener*)listener;
123 /** Called if the listener fails to open due to an error. */
124 - (void) listener: (TCPListener*)listener failedToOpen: (NSError*)error;
125 /** Called after the listener closes. */
126 - (void) listenerDidClose: (TCPListener*)listener;
127 /** Called when an incoming connection request arrives, but before the conncetion is opened;
128 return YES to accept the connection, NO to refuse it.
129 This method can only use criteria like the peer IP address, or the number of currently
130 open connections, to determine whether to accept. If you also want to check the
131 peer's SSL certificate, then return YES from this method, and use the TCPConnection
132 delegate method -connection:authorizeSSLPeer: to examine the certificate. */
133 - (BOOL) listener: (TCPListener*)listener shouldAcceptConnectionFrom: (IPAddress*)address;