File: DKMethodCall.h

package info (click to toggle)
dbuskit 0.1.1-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd, stretch
  • size: 3,552 kB
  • sloc: objc: 10,309; sh: 9,443; ansic: 200; makefile: 20
file content (83 lines) | stat: -rw-r--r-- 2,665 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
/** Interface for the DKMethodCall class for calling D-Bus methods.

   Copyright (C) 2010 Free Software Foundation, Inc.

   Written by:  Niels Grewe <niels.grewe@halbordnung.de>
   Created: June 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 "DKMessage.h"
#import <Foundation/NSDate.h>
@class DKMethod, DKProxy, NSInvocation;

/**
 * The DKMethodCall can be used to call methods on a remote object.
 */
@interface DKMethodCall: DKMessage
{
  /**
   * The method for which this is a call.
   */
  DKMethod *method;

  /**
   * The DKMethodCall object will read the arguments from the invocation and
   * also store the return value in it.
   */
   NSInvocation *invocation;

  /**
   * The timeout for the call;
   */
   NSInteger timeout;
}

/**
 * Initializes the method call to be sent to the object represented by the
 * proxy. This involves serializing the arguments from the invocation into D-Bus
 * format, but does include sending the message.
 */
- (id) initWithProxy: (DKProxy*)aProxy
              method: (DKMethod*)aMethod
          invocation: (NSInvocation*)anInvocation
             timeout: (NSTimeInterval)interval;

/**
 * Initializes the method call to be sent to the object represented by the
 * proxy. This involves serializing the arguments from the invocation into D-Bus
 * format, but does include sending the message. This method sets up a default
 * timeout.
 */
- (id) initWithProxy: (DKProxy*)aProxy
              method: (DKMethod*)aMethod
          invocation: (NSInvocation*)anInvocation;

/**
 * Sends the method call asynchronously via D-Bus. User code should retrieve
 * the DKPendingCall object corresponding to this method call in order to get
 * the return value.
 * FIXME: Not yet implemented
 */
- (void)sendAsynchronously;

/**
 * Sends the method call via D-Bus and waits until it completes (i.e. the result
 * of the call is deserialized as the return value of the invocation.)
 */
- (void)sendSynchronously;
@end