OSX/sec/securityd/asynchttp.h

   1 /*
   2  * Copyright (c) 2009-2010,2012-2015 Apple 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     @header asynchttp
  26     The functions provided in asynchttp.h provide an interface to
  27     an asynchronous http get/post engine.
  28 */
  29
  30 #ifndef _SECURITYD_ASYNCHTTP_H_
  31 #define _SECURITYD_ASYNCHTTP_H_
  32
  33 #include <stdbool.h>
  34 #include <CoreFoundation/CFData.h>
  35 #include <CoreFoundation/CFURL.h>
  36 #include <CoreFoundation/CFDate.h>
  37 #include <CFNetwork/CFHTTPMessage.h>
  38 #include <CFNetwork/CFHTTPStream.h>
  39 #include <dispatch/dispatch.h>
  40
  41 __BEGIN_DECLS
  42
  43 typedef struct asynchttp_s {
  44     void(*completed)(struct asynchttp_s *http, CFTimeInterval maxAge);
  45     void *info;
  46     CFHTTPMessageRef request;
  47     CFHTTPMessageRef response;
  48     dispatch_queue_t queue;
  49     uint64_t start_time;
  50     /* The fields below should be considered private. */
  51     CFMutableDataRef data;
  52     CFReadStreamRef stream;
  53     dispatch_source_t timer;
  54     CFDataRef token;
  55 } asynchttp_t;
  56
  57 /* Return false if work was scheduled and the callback will be invoked,
  58    true if it wasn't or the callback was already called. */
  59 bool asyncHttpPost(CFURLRef cfUrl, CFDataRef postData, uint64_t timeout, asynchttp_t *http);
  60
  61 /* Caller owns struct pointed to by http, but is responsible for calling
  62    asynchttp_free() when it's done with it. */
  63 bool asynchttp_request(CFHTTPMessageRef request, uint64_t timeout, asynchttp_t *http);
  64 void asynchttp_free(asynchttp_t *http);
  65
  66 /* */
  67
  68
  69 __END_DECLS
  70
  71 #endif /* !_SECURITYD_ASYNCHTTP_H_ */