1/*
2 * Copyright (c) 2012 Apple Computer, Inc. All Rights Reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. Please obtain a copy of the License at
10 * http://www.opensource.apple.com/apsl/ and read it before using this
11 * file.
12 *
13 * The Original Code and all software distributed under the License are
14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18 * Please see the License for the specific language governing rights and
19 * limitations under the License.
20 *
21 * @APPLE_LICENSE_HEADER_END@
22 */
23
24
25/*
26 * SOSCloudTransport.h -  Implementation of the transport layer from CKBridge to SOSAccount/SOSCircle
27 */
28
29/*!
30    @header SOSCloudTransport
31    The functions provided in SOSCloudTransport.h provide an interface
32    from CKBridge to SOSAccount/SOSCircle
33 */
34
35#ifndef _SOSCLOUDTRANSPORT_H_
36#define _SOSCLOUDTRANSPORT_H_
37
38#include <dispatch/dispatch.h>
39
40#include "SOSCloudKeychainClient.h"
41
42__BEGIN_DECLS
43
44/* CKPTransport. */
45
46/* CKPTransport protocol (not opaque). */
47typedef struct CloudTransport *SOSCloudTransportRef;
48struct CloudTransport
49{
50    void (*put)(SOSCloudTransportRef transport, CFDictionaryRef valuesToPut, dispatch_queue_t processQueue, CloudKeychainReplyBlock replyBlock);
51
52    void (*registerKeys)(SOSCloudTransportRef transport, CFArrayRef keysToGet, CFStringRef clientIdentifier, dispatch_queue_t processQueue, CloudKeychainReplyBlock replyBlock);
53    void (*unregisterKeys)(SOSCloudTransportRef transport, CFArrayRef keysToUnregister, CFStringRef clientIdentifier, dispatch_queue_t processQueue, CloudKeychainReplyBlock replyBlock);
54    void (*setItemsChangedBlock)(SOSCloudTransportRef transport, CloudKeychainReplyBlock icb);
55
56    // Debug calls
57    void (*get)(SOSCloudTransportRef transport, CFArrayRef keysToGet, dispatch_queue_t processQueue, CloudKeychainReplyBlock replyBlock);
58    void (*getAll)(SOSCloudTransportRef transport, dispatch_queue_t processQueue, CloudKeychainReplyBlock replyBlock);
59    void (*synchronize)(SOSCloudTransportRef transport, dispatch_queue_t processQueue, CloudKeychainReplyBlock replyBlock);
60    void (*clearAll)(SOSCloudTransportRef transport, dispatch_queue_t processQueue, CloudKeychainReplyBlock replyBlock);
61};
62
63/* Return the singleton cloud transport instance. */
64/* pass NULL for kvsID to use real KVS */
65SOSCloudTransportRef SOSCloudTransportDefaultTransport(CFStringRef kvsID, uint32_t options);
66
67__END_DECLS
68
69#endif /* !_SOSCLOUDTRANSPORT_H_ */
70