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