bindings/python/bt2/bt2/packet.py

   1 # The MIT License (MIT)
   2 #
   3 # Copyright (c) 2016-2017 Philippe Proulx <pproulx@efficios.com>
   4 #
   5 # Permission is hereby granted, free of charge, to any person obtaining a copy
   6 # of this software and associated documentation files (the "Software"), to deal
   7 # in the Software without restriction, including without limitation the rights
   8 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9 # copies of the Software, and to permit persons to whom the Software is
  10 # furnished to do so, subject to the following conditions:
  11 #
  12 # The above copyright notice and this permission notice shall be included in
  13 # all copies or substantial portions of the Software.
  14 #
  15 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  21 # THE SOFTWARE.
  22
  23 from bt2 import native_bt, object, utils
  24 import bt2.field
  25 import bt2.stream
  26 import copy
  27 import abc
  28 import bt2
  29
  30
  31 class _Packet(object._SharedObject):
  32     _get_ref = staticmethod(native_bt.packet_get_ref)
  33     _put_ref = staticmethod(native_bt.packet_put_ref)
  34
  35     @property
  36     def stream(self):
  37         stream_ptr = native_bt.packet_borrow_stream(self._ptr)
  38         assert stream_ptr is not None
  39         return bt2.stream._Stream._create_from_ptr_and_get_ref(stream_ptr)
  40
  41     @property
  42     def header_field(self):
  43         field_ptr = native_bt.packet_get_header(self._ptr)
  44
  45         if field_ptr is None:
  46             return
  47
  48         return bt2.field._create_from_ptr(field_ptr)
  49
  50     @header_field.setter
  51     def header_field(self, header_field):
  52         header_field_ptr = None
  53
  54         if header_field is not None:
  55             utils._check_type(header_field, bt2.field._Field)
  56             header_field_ptr = header_field._ptr
  57
  58         ret = native_bt.packet_set_header(self._ptr, header_field_ptr)
  59         utils._handle_ret(ret, "cannot set packet object's header field")
  60
  61     @property
  62     def context_field(self):
  63         field_ptr = native_bt.packet_borrow_context_field(self._ptr)
  64
  65         if field_ptr is None:
  66             return
  67
  68         return bt2.field._create_field_from_ptr(field_ptr, self._ptr,
  69                                                 self._get_ref,
  70                                                 self._put_ref)
  71
  72
  73     @context_field.setter
  74     def context_field(self, context_field):
  75         context_field_ptr = None
  76
  77         if context_field is not None:
  78             utils._check_type(context_field, bt2.field._Field)
  79             context_field_ptr = context_field._ptr
  80
  81         ret = native_bt.packet_set_context(self._ptr, context_field_ptr)
  82         utils._handle_ret(ret, "cannot set packet object's context field")
  83
  84     def __eq__(self, other):
  85         if type(other) is not type(self):
  86             return False
  87
  88         if self.addr == other.addr:
  89             return True
  90
  91         self_props = (
  92             self.header_field,
  93             self.context_field,
  94         )
  95         other_props = (
  96             other.header_field,
  97             other.context_field,
  98         )
  99         return self_props == other_props
 100
 101     def _copy(self, copy_func):
 102         cpy = self.stream.create_packet()
 103         cpy.header_field = copy_func(self.header_field)
 104         cpy.context_field = copy_func(self.context_field)
 105         return cpy
 106
 107     def __copy__(self):
 108         return self._copy(copy.copy)
 109
 110     def __deepcopy__(self, memo):
 111         cpy = self._copy(copy.deepcopy)
 112         memo[id(self)] = cpy
 113         return cpy