Source code for bosdyn.client.processors

# Copyright (c) 2020 Boston Dynamics, Inc.  All rights reserved.
# Downloading, reproducing, distributing or otherwise using the SDK Software
# is subject to the terms and conditions of the Boston Dynamics Software
# Development Kit License (20191101-BDSDK-SL).

"""Common message processors."""

from bosdyn.api.header_pb2 import RequestHeader
from bosdyn.util import now_nsec, set_timestamp_from_nsec  # bosdyn-core

[docs]class AddRequestHeader(object): """Sets header fields common to all bosdyn.api requests.""" def __init__(self, client_name_func): """Constructor, takes function to access the client name to insert into request headers.""" self.get_client_name = client_name_func def _create_header(self): header = RequestHeader() header.client_name = self.get_client_name() set_timestamp_from_nsec(header.request_timestamp, now_nsec()) return header
[docs] def mutate(self, request): """Mutate request such that its header contains a client name and a timestamp. Headers are not required for third party proto requests/responses. """ header = self._create_header() try: request.header.CopyFrom(header) except AttributeError: pass