diff options
Diffstat (limited to 'src/python/grpcio/grpc/_cython/_cygrpc/completion_queue.pyx.pxi')
| -rw-r--r-- | src/python/grpcio/grpc/_cython/_cygrpc/completion_queue.pyx.pxi | 146 |
1 files changed, 146 insertions, 0 deletions
diff --git a/src/python/grpcio/grpc/_cython/_cygrpc/completion_queue.pyx.pxi b/src/python/grpcio/grpc/_cython/_cygrpc/completion_queue.pyx.pxi new file mode 100644 index 0000000000..bbf8413299 --- /dev/null +++ b/src/python/grpcio/grpc/_cython/_cygrpc/completion_queue.pyx.pxi @@ -0,0 +1,146 @@ +# Copyright 2015, Google 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: +# +# * Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# * 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. +# * Neither the name of Google Inc. nor the names of its +# contributors may be used to endorse or promote products derived from +# this software without specific prior written permission. +# +# 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 +# OWNER 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. + +cimport cpython + +import threading +import time + + +cdef class CompletionQueue: + + def __cinit__(self): + self.c_completion_queue = grpc_completion_queue_create(NULL) + self.is_shutting_down = False + self.is_shutdown = False + self.poll_condition = threading.Condition() + self.is_polling = False + + cdef _interpret_event(self, grpc_event event): + cdef OperationTag tag = None + cdef object user_tag = None + cdef Call operation_call = None + cdef CallDetails request_call_details = None + cdef Metadata request_metadata = None + cdef Operations batch_operations = None + if event.type == GRPC_QUEUE_TIMEOUT: + return Event( + event.type, False, None, None, None, None, False, None) + elif event.type == GRPC_QUEUE_SHUTDOWN: + self.is_shutdown = True + return Event( + event.type, True, None, None, None, None, False, None) + else: + if event.tag != NULL: + tag = <OperationTag>event.tag + # We receive event tags only after they've been inc-ref'd elsewhere in + # the code. + cpython.Py_DECREF(tag) + if tag.shutting_down_server is not None: + tag.shutting_down_server.notify_shutdown_complete() + user_tag = tag.user_tag + operation_call = tag.operation_call + request_call_details = tag.request_call_details + request_metadata = tag.request_metadata + batch_operations = tag.batch_operations + if tag.is_new_request: + # Stuff in the tag not explicitly handled by us needs to live through + # the life of the call + operation_call.references.extend(tag.references) + return Event( + event.type, event.success, user_tag, operation_call, + request_call_details, request_metadata, tag.is_new_request, + batch_operations) + + def poll(self, Timespec deadline=None): + # We name this 'poll' to avoid problems with CPython's expectations for + # 'special' methods (like next and __next__). + cdef gpr_timespec c_deadline = gpr_inf_future( + GPR_CLOCK_REALTIME) + if deadline is not None: + c_deadline = deadline.c_time + cdef grpc_event event + + # Poll within a critical section + # TODO(atash) consider making queue polling contention a hard error to + # enable easier bug discovery + with self.poll_condition: + while self.is_polling: + self.poll_condition.wait(float(deadline) - time.time()) + self.is_polling = True + with nogil: + event = grpc_completion_queue_next( + self.c_completion_queue, c_deadline, NULL) + with self.poll_condition: + self.is_polling = False + self.poll_condition.notify() + return self._interpret_event(event) + + def pluck(self, OperationTag tag, Timespec deadline=None): + # Plucking a 'None' tag is equivalent to passing control to GRPC core until + # the deadline. + cdef gpr_timespec c_deadline = gpr_inf_future( + GPR_CLOCK_REALTIME) + if deadline is not None: + c_deadline = deadline.c_time + cdef grpc_event event + + # Poll within a critical section + # TODO(atash) consider making queue polling contention a hard error to + # enable easier bug discovery + with self.poll_condition: + while self.is_polling: + self.poll_condition.wait(float(deadline) - time.time()) + self.is_polling = True + with nogil: + event = grpc_completion_queue_pluck( + self.c_completion_queue, <cpython.PyObject *>tag, c_deadline, NULL) + with self.poll_condition: + self.is_polling = False + self.poll_condition.notify() + return self._interpret_event(event) + + def shutdown(self): + grpc_completion_queue_shutdown(self.c_completion_queue) + self.is_shutting_down = True + + def clear(self): + if not self.is_shutting_down: + raise ValueError('queue must be shutting down to be cleared') + while self.poll().type != GRPC_QUEUE_SHUTDOWN: + pass + + def __dealloc__(self): + if self.c_completion_queue != NULL: + # Ensure shutdown, pump the queue + if not self.is_shutting_down: + self.shutdown() + while not self.is_shutdown: + self.poll() + grpc_completion_queue_destroy(self.c_completion_queue) |