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 GRPC_CORE_LIB_IOMGR_SOCKET_MUTATOR_H 20 #define GRPC_CORE_LIB_IOMGR_SOCKET_MUTATOR_H 21 22 #include <grpc/support/port_platform.h> 23 24 #include <grpc/impl/codegen/grpc_types.h> 25 #include <grpc/support/sync.h> 26 27 #include <stdbool.h> 28 29 /** The virtual table of grpc_socket_mutator */ 30 struct grpc_socket_mutator_vtable { 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 }; 38 /** The Socket Mutator interface allows changes on socket options */ 39 struct grpc_socket_mutator { 40 const grpc_socket_mutator_vtable* vtable; 41 gpr_refcount refcount; 42 }; 43 44 /** called by concrete implementations to initialize the base struct */ 45 void grpc_socket_mutator_init(grpc_socket_mutator* mutator, 46 const grpc_socket_mutator_vtable* vtable); 47 48 /** Wrap \a mutator as a grpc_arg */ 49 grpc_arg grpc_socket_mutator_to_arg(grpc_socket_mutator* mutator); 50 51 /** Perform the file descriptor mutation operation of \a mutator on \a fd */ 52 bool grpc_socket_mutator_mutate_fd(grpc_socket_mutator* mutator, int fd); 53 54 /** Compare if \a a and \a b are the same mutator or have same settings */ 55 int grpc_socket_mutator_compare(grpc_socket_mutator* a, grpc_socket_mutator* b); 56 57 grpc_socket_mutator* grpc_socket_mutator_ref(grpc_socket_mutator* mutator); 58 void grpc_socket_mutator_unref(grpc_socket_mutator* mutator); 59 60 #endif /* GRPC_CORE_LIB_IOMGR_SOCKET_MUTATOR_H */ 61