mirror of
https://github.com/gnustep/libs-base.git
synced 2025-05-31 00:30:53 +00:00
Initial attempt at integration of NSNetServices support.
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@24272 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Richard Frith-MacDonald
parent
513e5b6722
commit
05a4bb2829
9 changed files with 4999 additions and 3180 deletions
438
Headers/Foundation/NSNetServices.h
Normal file
438
Headers/Foundation/NSNetServices.h
Normal file
|
|
@ -0,0 +1,438 @@
|
|||
/* Interface for NSNetServices for GNUstep
|
||||
Copyright (C) 2006 Free Software Foundation, Inc.
|
||||
|
||||
Written by: Chris B. Vetter
|
||||
Date: 2006
|
||||
|
||||
This file is part of the GNUstep Base Library.
|
||||
|
||||
This library is free software; you can redistribute it and/or
|
||||
modify it under the terms of the GNU Library General Public
|
||||
License as published by the Free Software Foundation; either
|
||||
version 2 of the License, or (at your option) any later version.
|
||||
|
||||
This library 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
|
||||
Library General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Library General Public
|
||||
License along with this library; if not, write to the Free
|
||||
Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
||||
Boston, MA 02111 USA.
|
||||
*/
|
||||
|
||||
#ifndef __NSNetServices_h_GNUSTEP_BASE_INCLUDE
|
||||
#define __NSNetServices_h_GNUSTEP_BASE_INCLUDE
|
||||
#import <GNUstepBase/GSVersionMacros.h>
|
||||
|
||||
#import <Foundation/NSObject.h>
|
||||
#import <Foundation/NSRange.h>
|
||||
|
||||
#if defined(__cplusplus)
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
typedef enum
|
||||
{
|
||||
/**
|
||||
* <list>
|
||||
* <item>
|
||||
* <strong>NSNetServicesUnknownError</strong><br />
|
||||
* An unknown error occurred.
|
||||
* <br /><br />
|
||||
* </item>
|
||||
* <item>
|
||||
* <strong>NSNetServicesCollisionError</strong><br />
|
||||
* The given registration has had a name collision. Registration should
|
||||
* be cancelled and tried again with a different name.
|
||||
* <br /><br />
|
||||
* </item>
|
||||
* <item>
|
||||
* <strong>NSNetServicesNotFoundError</strong><br />
|
||||
* The service could not be found.
|
||||
* <br /><br />
|
||||
* </item>
|
||||
* <item>
|
||||
* <strong>NSNetServicesActivityInProgress</strong><br />
|
||||
* A request is already in progress.
|
||||
* <br /><br />
|
||||
* </item>
|
||||
* <item>
|
||||
* <strong>NSNetServicesBadArgumentError</strong><br />
|
||||
* An invalid argument was used to create the object.
|
||||
* <br /><br />
|
||||
* </item>
|
||||
* <item>
|
||||
* <strong>NSNetServicesCancelledError</strong><br />
|
||||
* The request has been cancelled.
|
||||
* <br /><br />
|
||||
* </item>
|
||||
* <item>
|
||||
* <strong>NSNetServicesInvalidError</strong><br />
|
||||
* The service was improperly configured.
|
||||
* <br /><br />
|
||||
* </item>
|
||||
* <item>
|
||||
* <strong>NSNetServicesTimeoutError</strong><br />
|
||||
* The request has timed out before a successful resolution.
|
||||
* <br /><br />
|
||||
* </item>
|
||||
* </list>
|
||||
*/
|
||||
NSNetServicesUnknownError = -72000L,
|
||||
NSNetServicesCollisionError = -72001L,
|
||||
NSNetServicesNotFoundError = -72002L,
|
||||
NSNetServicesActivityInProgress = -72003L,
|
||||
NSNetServicesBadArgumentError = -72004L,
|
||||
NSNetServicesCancelledError = -72005L,
|
||||
NSNetServicesInvalidError = -72006L,
|
||||
NSNetServicesTimeoutError = -72007L
|
||||
} NSNetServicesError;
|
||||
|
||||
GS_EXPORT NSString * const NSNetServicesErrorCode;
|
||||
GS_EXPORT NSString * const NSNetServicesErrorDomain;
|
||||
|
||||
@class NSInputStream;
|
||||
@class NSOutputStream;
|
||||
@class NSRunLoop;
|
||||
|
||||
/**
|
||||
* <unit>
|
||||
* <heading>
|
||||
* NSNetService class description
|
||||
* </heading>
|
||||
* <p>
|
||||
* <!-- Foreword -->
|
||||
* </p>
|
||||
* <unit />
|
||||
* <p>
|
||||
* <!-- Afterword -->
|
||||
* </p>
|
||||
* </unit>
|
||||
* <p>
|
||||
* [NSNetService] lets you publish a network service in a domain using
|
||||
* multicast DNS. Additionally, it lets you resolve a network service that
|
||||
* was discovered by [NSNetServiceBrowser].
|
||||
* </p>
|
||||
*/
|
||||
|
||||
@interface NSNetService : NSObject
|
||||
{
|
||||
@private
|
||||
void * _netService;
|
||||
id _delegate;
|
||||
void * _reserved;
|
||||
}
|
||||
|
||||
+ (NSData *) dataFromTXTRecordDictionary: (NSDictionary *) txtDictionary;
|
||||
+ (NSDictionary *) dictionaryFromTXTRecordData: (NSData *) txtData;
|
||||
|
||||
- (id) initWithDomain: (NSString *) domain
|
||||
type: (NSString *) type
|
||||
name: (NSString *) name;
|
||||
- (id) initWithDomain: (NSString *) domain
|
||||
type: (NSString *) type
|
||||
name: (NSString *) name
|
||||
port: (int) port;
|
||||
|
||||
- (void) removeFromRunLoop: (NSRunLoop *) aRunLoop
|
||||
forMode: (NSString *) mode;
|
||||
- (void) scheduleInRunLoop: (NSRunLoop *) aRunLoop
|
||||
forMode: (NSString *) mode;
|
||||
|
||||
- (void) publish;
|
||||
- (void) resolve;
|
||||
- (void) resolveWithTimeout: (NSTimeInterval) timeout;
|
||||
- (void) stop;
|
||||
|
||||
- (void) startMonitoring;
|
||||
- (void) stopMonitoring;
|
||||
|
||||
- (id) delegate;
|
||||
- (void) setDelegate: (id) delegate;
|
||||
|
||||
- (NSArray *) addresses;
|
||||
- (NSString *) domain;
|
||||
- (NSString *) hostName;
|
||||
- (NSString *) name;
|
||||
- (NSString *) type;
|
||||
|
||||
- (NSString *) protocolSpecificInformation;
|
||||
- (void) setProtocolSpecificInformation: (NSString *) specificInformation;
|
||||
|
||||
- (NSData *) TXTRecordData;
|
||||
- (BOOL) setTXTRecordData: (NSData *) recordData;
|
||||
|
||||
- (BOOL) getInputStream: (NSInputStream **) inputStream
|
||||
outputStream: (NSOutputStream **) outputStream;
|
||||
|
||||
@end
|
||||
|
||||
/**
|
||||
* <unit>
|
||||
* <heading>
|
||||
* NSNetServiceBrowser class description
|
||||
* </heading>
|
||||
* <p>
|
||||
* <!-- Foreword -->
|
||||
* </p>
|
||||
* <unit />
|
||||
* <p>
|
||||
* <!-- Afterword -->
|
||||
* </p>
|
||||
* </unit>
|
||||
* <p>
|
||||
* [NSNetServiceBrowser] asynchronously lets you discover network domains
|
||||
* and, additionally, search for a type of network service. It sends its
|
||||
* delegate a message whenever it discovers a new network service, and
|
||||
* whenever a network service goes away.
|
||||
* </p>
|
||||
* <p>
|
||||
* Each [NSNetServiceBrowser] performs one search at a time. So in order
|
||||
* to perform multiple searches simultaneously, create multiple instances.
|
||||
* </p>
|
||||
*/
|
||||
|
||||
@interface NSNetServiceBrowser : NSObject
|
||||
{
|
||||
@private
|
||||
void * _netServiceBrowser;
|
||||
id _delegate;
|
||||
void * _reserved;
|
||||
}
|
||||
|
||||
- (id) init;
|
||||
|
||||
- (void) removeFromRunLoop: (NSRunLoop *) aRunLoop
|
||||
forMode: (NSString *) mode;
|
||||
- (void) scheduleInRunLoop: (NSRunLoop *) aRunLoop
|
||||
forMode: (NSString *) mode;
|
||||
|
||||
- (void) searchForAllDomains;
|
||||
- (void) searchForBrowsableDomains;
|
||||
- (void) searchForRegistrationDomains;
|
||||
|
||||
- (void) searchForServicesOfType: (NSString *) serviceType
|
||||
inDomain: (NSString *) domainName;
|
||||
|
||||
- (void) stop;
|
||||
|
||||
- (id) delegate;
|
||||
- (void) setDelegate: (id) delegate;
|
||||
|
||||
@end
|
||||
|
||||
/**
|
||||
* <unit>
|
||||
* <heading>
|
||||
* NSObject (NSNetServiceDelegateMethods) class description
|
||||
* </heading>
|
||||
* <p>
|
||||
* <!-- Foreword -->
|
||||
* </p>
|
||||
* <unit />
|
||||
* <p>
|
||||
* <!-- Afterword -->
|
||||
* </p>
|
||||
* </unit>
|
||||
* <p>
|
||||
* This informal protocol must be adopted by any class wishing to implement
|
||||
* an [NSNetService] delegate.
|
||||
* </p>
|
||||
*/
|
||||
|
||||
@interface NSObject (NSNetServiceDelegateMethods)
|
||||
|
||||
/**
|
||||
* Notifies the delegate that the network is ready to publish the service.
|
||||
*
|
||||
* <p><strong>See also:</strong><br />
|
||||
* [NSNetService-publish]<br />
|
||||
* </p>
|
||||
*/
|
||||
|
||||
- (void) netServiceWillPublish: (NSNetService *) sender;
|
||||
|
||||
/**
|
||||
* Notifies the delegate that the service was successfully published.
|
||||
*
|
||||
* <p><strong>See also:</strong><br />
|
||||
* [NSNetService-publish]<br />
|
||||
* </p>
|
||||
*/
|
||||
|
||||
- (void) netServiceDidPublish: (NSNetService *) sender;
|
||||
|
||||
/**
|
||||
* Notifies the delegate that the service could not get published.
|
||||
*
|
||||
* <p><strong>See also:</strong><br />
|
||||
* [NSNetService-publish]<br />
|
||||
* </p>
|
||||
*/
|
||||
|
||||
- (void) netService: (NSNetService *) sender
|
||||
didNotPublish: (NSDictionary *) errorDict;
|
||||
|
||||
/**
|
||||
* Notifies the delegate that the network is ready to resolve the service.
|
||||
*
|
||||
* <p><strong>See also:</strong><br />
|
||||
* [NSNetService-resolveWithTimeout:]<br />
|
||||
* </p>
|
||||
*/
|
||||
|
||||
- (void) netServiceWillResolve: (NSNetService *) sender;
|
||||
|
||||
/**
|
||||
* Notifies the delegate that the service was resolved.
|
||||
*
|
||||
* <p><strong>See also:</strong><br />
|
||||
* [NSNetService-resolveWithTimeout:]<br />
|
||||
* </p>
|
||||
*/
|
||||
|
||||
- (void) netServiceDidResolveAddress: (NSNetService *) sender;
|
||||
|
||||
/**
|
||||
* Notifies the delegate that the service could not get resolved.
|
||||
*
|
||||
* <p><strong>See also:</strong><br />
|
||||
* [NSNetService-resolveWithTimeout:]<br />
|
||||
* </p>
|
||||
*/
|
||||
|
||||
- (void) netService: (NSNetService *) sender
|
||||
didNotResolve: (NSDictionary *) errorDict;
|
||||
|
||||
/**
|
||||
* Notifies the delegate that the request was stopped.
|
||||
*
|
||||
* <p><strong>See also:</strong><br />
|
||||
* [NSNetService-stop]<br />
|
||||
* </p>
|
||||
*/
|
||||
|
||||
- (void) netServiceDidStop: (NSNetService *) sender;
|
||||
|
||||
/**
|
||||
* Notifies the delegate that the TXT record has been updated.
|
||||
*
|
||||
* <p><strong>See also:</strong><br />
|
||||
* [NSNetService-startMonitoring]<br />
|
||||
* [NSNetService-stopMonitoring]
|
||||
* </p>
|
||||
*/
|
||||
|
||||
- (void) netService: (NSNetService *) sender
|
||||
didUpdateTXTRecordData: (NSData *) data;
|
||||
|
||||
@end
|
||||
|
||||
/**
|
||||
* <unit>
|
||||
* <heading>
|
||||
* NSObject (NSNetServiceBrowserDelegateMethods) class description
|
||||
* </heading>
|
||||
* <p>
|
||||
* <!-- Foreword -->
|
||||
* </p>
|
||||
* <unit />
|
||||
* <p>
|
||||
* <!-- Afterword -->
|
||||
* </p>
|
||||
* </unit>
|
||||
* <p>
|
||||
* This informal protocol must be adopted by any class wishing to implement
|
||||
* an [NSNetServiceBrowser] delegate.
|
||||
* </p>
|
||||
*/
|
||||
|
||||
@interface NSObject (NSNetServiceBrowserDelegateMethods)
|
||||
|
||||
/**
|
||||
* Notifies the delegate that the search is about to begin.
|
||||
*
|
||||
* <p><strong>See also:</strong><br />
|
||||
* [NSNetServiceBrowser-netServiceBrowser:didNotSearch:]<br />
|
||||
* </p>
|
||||
*/
|
||||
|
||||
- (void) netServiceBrowserWillSearch: (NSNetServiceBrowser *)aNetServiceBrowser;
|
||||
|
||||
/**
|
||||
* Notifies the delegate that the search was unsuccessful.
|
||||
*
|
||||
* <p><strong>See also:</strong><br />
|
||||
* [NSNetServiceBrowser-netServiceBrowserWillSearch:]<br />
|
||||
* </p>
|
||||
*/
|
||||
|
||||
- (void) netServiceBrowser: (NSNetServiceBrowser *) aNetServiceBrowser
|
||||
didNotSearch: (NSDictionary *) errorDict;
|
||||
|
||||
/**
|
||||
* Notifies the delegate that the search was stopped.
|
||||
*
|
||||
* <p><strong>See also:</strong><br />
|
||||
* [NSNetServiceBrowser-stop]<br />
|
||||
* </p>
|
||||
*/
|
||||
|
||||
- (void) netServiceBrowserDidStopSearch:
|
||||
(NSNetServiceBrowser *)aNetServiceBrowser;
|
||||
|
||||
/**
|
||||
* Notifies the delegate that a domain was found.
|
||||
*
|
||||
* <p><strong>See also:</strong><br />
|
||||
* [NSNetServiceBrowser-searchForBrowsableDomains]<br />
|
||||
* [NSNetServiceBrowser-searchForRegistrationDomains]<br />
|
||||
* </p>
|
||||
*/
|
||||
|
||||
- (void) netServiceBrowser: (NSNetServiceBrowser *) aNetServiceBrowser
|
||||
didFindDomain: (NSString *) domainString
|
||||
moreComing: (BOOL) moreComing;
|
||||
|
||||
/**
|
||||
* Notifies the delegate that a domain has become unavailable.
|
||||
*
|
||||
* <p><strong>See also:</strong><br />
|
||||
* <br />
|
||||
* </p>
|
||||
*/
|
||||
|
||||
- (void) netServiceBrowser: (NSNetServiceBrowser *) aNetServiceBrowser
|
||||
didRemoveDomain: (NSString *) domainString
|
||||
moreComing: (BOOL) moreComing;
|
||||
|
||||
/**
|
||||
* Notifies the delegate that a service was found.
|
||||
*
|
||||
* <p><strong>See also:</strong><br />
|
||||
* [NSNetServiceBrowser-searchForServicesOfType:inDomain:]<br />
|
||||
* </p>
|
||||
*/
|
||||
|
||||
- (void) netServiceBrowser: (NSNetServiceBrowser *) aNetServiceBrowser
|
||||
didFindService: (NSNetService *) aNetService
|
||||
moreComing: (BOOL) moreComing;
|
||||
|
||||
/**
|
||||
* Notifies the delegate that a service has become unavailable.
|
||||
*
|
||||
* <p><strong>See also:</strong><br />
|
||||
* <br />
|
||||
* </p>
|
||||
*/
|
||||
|
||||
- (void) netServiceBrowser: (NSNetServiceBrowser *) aNetServiceBrowser
|
||||
didRemoveService: (NSNetService *) aNetService
|
||||
moreComing: (BOOL) moreComing;
|
||||
|
||||
@end
|
||||
|
||||
#endif /* __NSNetServices_h_GNUSTEP_BASE_INCLUDE */
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue