Rename WKProcessClass to WKProcessPool
[WebKit-https.git] / Source / WebKit2 / UIProcess / API / Cocoa / WKProcessPool.h
1 /*
2  * Copyright (C) 2014 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #import <Foundation/Foundation.h>
27 #import <WebKit2/WKFoundation.h>
28
29 #if WK_API_ENABLED
30
31 @class WKProcessPoolConfiguration;
32
33 /*! A WKProcessPool defines a distinct type-or category-of Web Content process.
34  A @link WKWebView @/link specifies the WKProcessPool of the Web
35  Content process backing it through its @link WKWebViewConfiguration @/link.
36  @helperclass @link WKProcessPoolConfiguration @/link
37  Used to configure @link WKProcessPool @/link instances.
38  */
39 WK_API_CLASS
40 @interface WKProcessPool : NSObject
41
42 /*! @abstract A copy of the configuration with which the @link WKProcessPool @/link was
43         initialized.
44 */
45 @property (nonatomic, readonly) WKProcessPoolConfiguration *configuration;
46
47 /*!
48     @abstract Returns an instance initialized with the specified configuration.
49     @param configuration The configuration for the new instance.
50     @result An initialized instance, or nil if the object could not be initialized.
51     @discussion This is a designated initializer. You can use @link -init @/link to initialize an
52         instance with the default configuration.
53
54         The initializer copies
55         @link //apple_ref/doc/methodparam/WKProcessPool/initWithConfiguration:/configuration
56         configuration@/link, so mutating it after initialization has no effect on the
57         @link WKProcessPool @/link instance.
58 */
59 - (instancetype)initWithConfiguration:(WKProcessPoolConfiguration *)configuration WK_DESIGNATED_INITIALIZER;
60
61 @end
62
63 #endif