1  /*
 2   * Copyright (c) 2010-2011 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  #ifndef _SEC_TRANSFORM_READ_TRANSFORM_H
25  #define _SEC_TRANSFORM_READ_TRANSFORM_H
26  
27  #ifdef __cplusplus
28  extern "C" {
29  #endif
30  
31  #include <Security/SecTransform.h>
32  
33  CF_ASSUME_NONNULL_BEGIN
34  CF_IMPLICIT_BRIDGING_ENABLED
35  
36  /*!
37  	@header
38  
39  			The read transform reads bytes from a instance.  The bytes are
40  			sent as CFDataRef instances to the OUTPUT attribute of the
41  			transform.
42  				
43  			This transform recognizes the following additional attributes
44  			that can be used to modify its behavior:
45  				
46  			MAX_READSIZE (expects CFNumber):  changes the maximum number of
47  			bytes the transform will attempt to read from the stream.  Note
48  			that the transform may deliver fewer bytes than this depending
49  			on the stream being used.
50  */
51  
52  /*!
53  	@function	SecTransformCreateReadTransformWithReadStream
54  	
55  	@abstract	Creates a read transform from a CFReadStreamRef
56  	
57  	@param inputStream	The stream that is to be opened and read from when
58  				the chain executes.
59  */
60  
61  SecTransformRef SecTransformCreateReadTransformWithReadStream(CFReadStreamRef inputStream)
62  	__OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_NA);
63  
64  CF_IMPLICIT_BRIDGING_DISABLED
65  CF_ASSUME_NONNULL_END
66  
67  #ifdef __cplusplus
68  };
69  #endif
70  
71  #endif
72