darling-dbuskit/Headers/DKPortNameServer.h
Niels Grewe c7c8d3dbf0 More expressive return codes for bus name requests
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/dbuskit/trunk@40504 72102866-910b-0410-8b05-ffd578937521
2017-05-15 20:40:32 +00:00

105 lines
3.0 KiB
Objective-C

/** Interface for DKPortNameServer for NSConnection integration.
Copyright (C) 2011 Free Software Foundation, Inc.
Written by: Niels Grewe <niels.grewe@halbordnung.de>
Created: February 2011
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser 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 Lesser 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.
*/
#import <Foundation/NSObject.h>
#import <DBusKit/DKPort.h>
#include <stdint.h>
@class DKPort, NSHashTable, NSMutableDictionary, NSRecursiveLock, NSString;
typedef NS_OPTIONS(NSUInteger, DKPortNameFlags)
{
DKPortNameAllowReplacement = 1 << 0,
DKPortNameDoNotQueue = 1 << 1,
DKPortNameReplaceExisting = 1 << 2,
DKPortNameFlagMax = 7
};
/**
* The status returned by D-Bus in response to a request to register a name.
*/
typedef NS_ENUM(uint32_t, DKPortNameRegistrationStatus)
{
/**
* The port is now the primary owner of the name.
*/
DKPortNamePrimaryOwner = 1,
/**
* The name has been queued and will be assigned to the port once previous
* registrands of the name go away.
*/
DKPortNameQueued = 2,
/**
* The name is already in use by a different port, but queuing was not
* requested.
*/
DKPortNameExists = 3,
/**
* The port had already been registered by the port. No changes occurred.
*/
DKPortNameAlreadyOwner = 4
};
@interface DKPortNameServer: NSObject
{
@private
/**
* The type of the well-known bus that the nameserver is responsible for.
*/
DKDBusBusType busType;
/**
* Contains all names the local connection is queued for. They will
* become active names once the present owner and all preceding members of the
* queue have ceased using the name.
*/
NSHashTable *queuedNames;
/**
* Contains all names active for the local connection.
*/
NSHashTable *activeNames;
/**
* The lock protecting the tables.
*/
NSRecursiveLock *lock;
}
+ (id)sharedSystemBusPortNameServer;
+ (id)sharedSessionBusPortNameServer;
+ (id)sharedPortNameServerForBusType: (DKDBusBusType)type;
- (DKPort*)portForName: (NSString*)name;
- (DKPortNameRegistrationStatus)registerPort: (DKPort*)port
name: (NSString*)name;
- (DKPortNameRegistrationStatus)registerPort: (DKPort*)port
name: (NSString*)name
flags: (DKPortNameFlags)flags;
- (void)removePortForName: (NSString*)name;
@end