3 * Copyright 2015 gRPC authors.
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #ifndef GRPC_CORE_LIB_IOMGR_SOCKET_MUTATOR_H
20 #define GRPC_CORE_LIB_IOMGR_SOCKET_MUTATOR_H
22 #include <grpc/support/port_platform.h>
24 #include <grpc/impl/codegen/grpc_types.h>
25 #include <grpc/support/sync.h>
29 /** The virtual table of grpc_socket_mutator */
31 /** Mutates the socket options of \a fd */
32 bool (*mutate_fd)(int fd, grpc_socket_mutator* mutator);
33 /** Compare socket mutator \a a and \a b */
34 int (*compare)(grpc_socket_mutator* a, grpc_socket_mutator* b);
35 /** Destroys the socket mutator instance */
36 void (*destroy)(grpc_socket_mutator* mutator);
37 } grpc_socket_mutator_vtable;
39 /** The Socket Mutator interface allows changes on socket options */
40 struct grpc_socket_mutator {
41 const grpc_socket_mutator_vtable* vtable;
42 gpr_refcount refcount;
45 /** called by concrete implementations to initialize the base struct */
46 void grpc_socket_mutator_init(grpc_socket_mutator* mutator,
47 const grpc_socket_mutator_vtable* vtable);
49 /** Wrap \a mutator as a grpc_arg */
50 grpc_arg grpc_socket_mutator_to_arg(grpc_socket_mutator* mutator);
52 /** Perform the file descriptor mutation operation of \a mutator on \a fd */
53 bool grpc_socket_mutator_mutate_fd(grpc_socket_mutator* mutator, int fd);
55 /** Compare if \a a and \a b are the same mutator or have same settings */
56 int grpc_socket_mutator_compare(grpc_socket_mutator* a, grpc_socket_mutator* b);
58 grpc_socket_mutator* grpc_socket_mutator_ref(grpc_socket_mutator* mutator);
59 void grpc_socket_mutator_unref(grpc_socket_mutator* mutator);
61 #endif /* GRPC_CORE_LIB_IOMGR_SOCKET_MUTATOR_H */