/* FILE: NSNetServices.h
*
* Project Tryst
* Class NSNetServices
* Creator Chris B. Vetter
* Maintainer Chris B. Vetter
* Creation Date Mon Sep 11 14:46:24 CEST 2006
*
* Copyright (c) 2006
*
* Tryst is free software under the terms of a dual BSD/LGPL license.
* For a full copyright description, see the COPYRIGHT file.
*
***************************************************************************/
#ifndef _NSNETSERVICES_H_
#define _NSNETSERVICES_H_ 1
/***************************************************************************/
//
// Include
//
#import <Foundation/NSObject.h>
//
// Define
//
//
// Typedef
//
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;
//
// Public
//
extern NSString * const NSNetServicesErrorCode;
extern NSString * const NSNetServicesErrorDomain;
//
// Referenced Classes
//
@class NSInputStream,
NSOutputStream,
NSRunLoop;
//
// Interface
//
/**
* <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;
}
//
// Factory Methods
//
+ (NSData *) dataFromTXTRecordDictionary: (NSDictionary *) txtDictionary;
+ (NSDictionary *) dictionaryFromTXTRecordData: (NSData *) txtData;
//
// Instance Methods
//
- (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;
//
// Accessor Methods
//
- (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
/***************************************************************************/
//
// Interface
//
/**
* <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;
}
//
// Factory Methods
//
//
// Instance Methods
//
- (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;
//
// Accessor Methods
//
- (id) delegate;
- (void) setDelegate: (id) delegate;
@end
/***************************************************************************/
//
// Interface
//
/**
* <unit>
* <heading>
* NSObject (NSNetServiceDelegateMethods) category 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
/***************************************************************************/
//
// Interface
//
/**
* <unit>
* <heading>
* NSObject (NSNetServiceBrowserDelegateMethods) category 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
/***************************************************************************/
//
// Prototypes
//
/***************************************************************************/
#endif
syntax highlighted by Code2HTML, v. 0.9.1