darling-dbuskit/Source/DKEndpoint.h
Niels Grewe 383d61bf75 Merge DBusKit-ThreadRewrite branch. DBusKit now offloads all interactions with
libdbus to a separate thread and uses DKEndpointManager as a gateway to do so.
The new behaviour is disabled by default and can be enabled by calling [DKPort
enableWorkerThread].
This also contains various smaller improvements and fixes bugs that were exposed
when stuff was taking place asynchronously.



git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/dbuskit/trunk@32178 72102866-910b-0410-8b05-ffd578937521
2011-02-15 22:05:24 +00:00

83 lines
2.5 KiB
Objective-C

/** Declaration of DKEndpoint class for integrating DBus into NSRunLoop.
Copyright (C) 2010 Free Software Foundation, Inc.
Written by: Niels Grewe <niels.grewe@halbordnung.de>
Created: May 2010
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 <dbus/dbus.h>
@class DKRunLoopContext, NSRunLoop, NSString, NSDictionary;
@protocol NSCoding;
/**
* DKEndpoint is used internally to manage the low level details of a connection
* to a D-Bus peer. This can be a well known bus as well as some special peer.
*/
@interface DKEndpoint: NSObject <NSCoding>
{
DBusConnection *connection;
NSDictionary *info;
DKRunLoopContext *ctx;
}
/**
* Use this initializer to use a pre-existing DBusConnection. Please note that
* this will increase the reference count of the connection. It will still need
* to be unreferenced by calling code.
*
* Please note that encoding and decoding an DKEndpoint encoded this way is only
* possible if you also supply a proper info dictionary. This dictionary should
* contain either the address of the bus (under the "address"-key) or the type
* of the well-known bus (under the "wellKnownBus"-key).
*/
- (id) initWithConnection: (DBusConnection*)conn
info: (NSDictionary*)info;
/**
* Returns the libdbus DBusConnection object.
*/
- (DBusConnection*) DBusConnection;
/**
* Returns the type of the well known bus for this endpoint, or
* DKDBusBusTypeOther does not connect to a well known bus.
*/
- (DKDBusBusType)DBusBusType;
/**
* Flush the connection, so that it will marshall all pending messages to the
* wire.
*/
- (void) flush;
/**
* Returns the run loop in which D-Bus connections are handled.
*/
- (NSRunLoop*)runLoop;
/**
* Returns the run loop mode in which D-Bus connections are handled.
*/
- (NSString*)runLoopMode;
@end