File: process.h

package info (click to toggle)
libwpe 1.16.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 748 kB
  • sloc: ansic: 5,890; sh: 102; cpp: 57; python: 51; makefile: 5
file content (162 lines) | stat: -rw-r--r-- 4,637 bytes parent folder | download | duplicates (3)
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
/*
 * Copyright (C) 2022 Sony Interactive Entertainment Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#if !defined(__WPE_H_INSIDE__) && !defined(WPE_COMPILATION)
#error "Only <wpe/wpe.h> can be included directly."
#endif

#ifndef wpe_process_h
#define wpe_process_h

/**
 * SECTION:process
 * @short_description: Process management
 * @title: Process
 */

#if defined(WPE_COMPILATION)
#include "export.h"
#endif

#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * wpe_process_type:
 * @WPE_PROCESS_TYPE_WEB: WebKit's WebProcess.
 * @WPE_PROCESS_TYPE_NETWORK: WebKit's NetworkProcess.
 * @WPE_PROCESS_TYPE_GPU: WebKit's GPUProcess.
 * @WPE_PROCESS_TYPE_WEB_AUTHN: WebKit's WebAuthNProcess.
 *
 * Maps to the processes launched by WebKit.
 */
enum wpe_process_type {
    WPE_PROCESS_TYPE_WEB,
    WPE_PROCESS_TYPE_NETWORK,
    WPE_PROCESS_TYPE_GPU,
    WPE_PROCESS_TYPE_WEB_AUTHN,
};

struct wpe_process_provider;

/**
 * wpe_process_provider_interface:
 * @create: create an internal representation of a process provider.
 * @destroy: destroy instance process provider.
 * @launch: launches the specified WebKit process.
 * @terminate: terminates the specified Webkit process.
 *
 * Methods called by WebKit requesting process provider operations to implementator.
 *
 * Since: 1.14
 */
struct wpe_process_provider_interface {
    void* (*create)(struct wpe_process_provider*);
    void (*destroy)(void*);
    int64_t (*launch)(void*, enum wpe_process_type, void*);
    void (*terminate)(void*, int64_t);

    /*< private >*/
    void (*_wpe_reserved1)(void);
    void (*_wpe_reserved2)(void);
    void (*_wpe_reserved3)(void);
    void (*_wpe_reserved4)(void);
    void (*_wpe_reserved5)(void);
};

/**
 * wpe_process_provider_create:
 *
 * This method is called by WPEWebKit.
 *
 * Returns: an opaque object representing the process provider in libwpe.
 *
 * Since: 1.14
 */
WPE_EXPORT
struct wpe_process_provider* wpe_process_provider_create(void);

/**
 * wpe_process_provider_destroy:
 * @provider: opaque libwpe's representation of the process provider.
 *
 * Frees the internal resources used by @provider.
 *
 * This method is called by WPEWebKit.
 *
 * Since: 1.14
 */
WPE_EXPORT
void wpe_process_provider_destroy(struct wpe_process_provider*);

/**
 * wpe_process_launch:
 * @provider: opaque libwpe's representation of the process provider.
 * @type: the process type to launch.
 * @userdata: user data passed needed to launch the process.
 *
 * Launches the specified WebKit process.
 *
 * Returns: an identifier for the process.
 *
 * Since: 1.14
 */
WPE_EXPORT
int64_t wpe_process_launch(struct wpe_process_provider*, enum wpe_process_type, void*);

/**
 * wpe_process_terminate:
 * @provider: opaque libwpe's representation of the process provider.
 * @process: identifier for the process to terminate.
 *
 * Terminates the specified WebKit process.
 *
 * Since: 1.14
 */
WPE_EXPORT
void wpe_process_terminate(struct wpe_process_provider*, int64_t);

/**
 * wpe_process_provider_register_interface:
 * @iface: interface for the process provider.
 *
 * Sets the process provider interface.
 *
 * This method is called by WPEWebKit.
 *
 * Since: 1.14
 */
WPE_EXPORT
void wpe_process_provider_register_interface(const struct wpe_process_provider_interface*);

#ifdef __cplusplus
}
#endif

#endif /* wpe_process_h */