xref: /aosp_15_r20/external/grpc-grpc/src/php/ext/grpc/call.h (revision cc02d7e222339f7a4f6ba5f422e6413f4bd931f2)
1*cc02d7e2SAndroid Build Coastguard Worker /*
2*cc02d7e2SAndroid Build Coastguard Worker  *
3*cc02d7e2SAndroid Build Coastguard Worker  * Copyright 2015 gRPC authors.
4*cc02d7e2SAndroid Build Coastguard Worker  *
5*cc02d7e2SAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
6*cc02d7e2SAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
7*cc02d7e2SAndroid Build Coastguard Worker  * You may obtain a copy of the License at
8*cc02d7e2SAndroid Build Coastguard Worker  *
9*cc02d7e2SAndroid Build Coastguard Worker  *     http://www.apache.org/licenses/LICENSE-2.0
10*cc02d7e2SAndroid Build Coastguard Worker  *
11*cc02d7e2SAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
12*cc02d7e2SAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
13*cc02d7e2SAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14*cc02d7e2SAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
15*cc02d7e2SAndroid Build Coastguard Worker  * limitations under the License.
16*cc02d7e2SAndroid Build Coastguard Worker  *
17*cc02d7e2SAndroid Build Coastguard Worker  */
18*cc02d7e2SAndroid Build Coastguard Worker 
19*cc02d7e2SAndroid Build Coastguard Worker #ifndef NET_GRPC_PHP_GRPC_CALL_H_
20*cc02d7e2SAndroid Build Coastguard Worker #define NET_GRPC_PHP_GRPC_CALL_H_
21*cc02d7e2SAndroid Build Coastguard Worker 
22*cc02d7e2SAndroid Build Coastguard Worker #include "php_grpc.h"
23*cc02d7e2SAndroid Build Coastguard Worker 
24*cc02d7e2SAndroid Build Coastguard Worker #include "channel.h"
25*cc02d7e2SAndroid Build Coastguard Worker 
26*cc02d7e2SAndroid Build Coastguard Worker /* Class entry for the Call PHP class */
27*cc02d7e2SAndroid Build Coastguard Worker extern zend_class_entry *grpc_ce_call;
28*cc02d7e2SAndroid Build Coastguard Worker 
29*cc02d7e2SAndroid Build Coastguard Worker /* Wrapper struct for grpc_call that can be associated with a PHP object */
30*cc02d7e2SAndroid Build Coastguard Worker PHP_GRPC_WRAP_OBJECT_START(wrapped_grpc_call)
31*cc02d7e2SAndroid Build Coastguard Worker   bool owned;
32*cc02d7e2SAndroid Build Coastguard Worker   grpc_call *wrapped;
33*cc02d7e2SAndroid Build Coastguard Worker   wrapped_grpc_channel* channel;
PHP_GRPC_WRAP_OBJECT_END(wrapped_grpc_call)34*cc02d7e2SAndroid Build Coastguard Worker PHP_GRPC_WRAP_OBJECT_END(wrapped_grpc_call)
35*cc02d7e2SAndroid Build Coastguard Worker 
36*cc02d7e2SAndroid Build Coastguard Worker static inline wrapped_grpc_call
37*cc02d7e2SAndroid Build Coastguard Worker *wrapped_grpc_call_from_obj(zend_object *obj) {
38*cc02d7e2SAndroid Build Coastguard Worker   return (wrapped_grpc_call*)((char*)(obj) -
39*cc02d7e2SAndroid Build Coastguard Worker                               XtOffsetOf(wrapped_grpc_call, std));
40*cc02d7e2SAndroid Build Coastguard Worker }
41*cc02d7e2SAndroid Build Coastguard Worker 
42*cc02d7e2SAndroid Build Coastguard Worker /* Creates and returns a PHP associative array of metadata from a C array of
43*cc02d7e2SAndroid Build Coastguard Worker  * call metadata */
44*cc02d7e2SAndroid Build Coastguard Worker zval *grpc_parse_metadata_array(grpc_metadata_array *metadata_array TSRMLS_DC);
45*cc02d7e2SAndroid Build Coastguard Worker 
46*cc02d7e2SAndroid Build Coastguard Worker /* Creates a Call object that wraps the given grpc_call struct */
47*cc02d7e2SAndroid Build Coastguard Worker zval *grpc_php_wrap_call(grpc_call *wrapped, bool owned TSRMLS_DC);
48*cc02d7e2SAndroid Build Coastguard Worker 
49*cc02d7e2SAndroid Build Coastguard Worker /* Initializes the Call PHP class */
50*cc02d7e2SAndroid Build Coastguard Worker void grpc_init_call(TSRMLS_D);
51*cc02d7e2SAndroid Build Coastguard Worker 
52*cc02d7e2SAndroid Build Coastguard Worker /* Populates a grpc_metadata_array with the data in a PHP array object.
53*cc02d7e2SAndroid Build Coastguard Worker    Returns true on success and false on failure */
54*cc02d7e2SAndroid Build Coastguard Worker bool create_metadata_array(zval *array, grpc_metadata_array *metadata);
55*cc02d7e2SAndroid Build Coastguard Worker void grpc_php_metadata_array_destroy_including_entries(
56*cc02d7e2SAndroid Build Coastguard Worker     grpc_metadata_array* array);
57*cc02d7e2SAndroid Build Coastguard Worker #endif /* NET_GRPC_PHP_GRPC_CHANNEL_H_ */
58