Skip to main content

general purpose bidirectional packet stream connection

Project description

A general purpose bidirectional packet stream connection.

Latest release 20211208:

  • Packet.eq: only test .rq_type if .is_request.
  • Update tests for changes.

Class Packet(cs.binary.SimpleBinary,types.SimpleNamespace,cs.binary.AbstractBinary,cs.binary.BinaryMixin)

A protocol packet.

Method Packet.__str__(self)

pylint: disable=signature-differs

Method Packet.parse(bfr)

Parse a packet from a buffer.

Method Packet.transcribe(self)

Transcribe this packet.

Class PacketConnection

A bidirectional binary connection for exchanging requests and responses.

Method PacketConnection.__init__(self, recv, send, request_handler=None, name=None, packet_grace=None, tick=None)

Initialise the PacketConnection.

Parameters:

  • recv: inbound binary stream. If this is an int it is taken to be an OS file descriptor, otherwise it should be a cs.buffer.CornuCopyBuffer or a file like object with a read1 or read method.
  • send: outbound binary stream. If this is an int it is taken to be an OS file descriptor, otherwise it should be a file like object with .write(bytes) and .flush() methods. For a file descriptor sending is done via an os.dup() of the supplied descriptor, so the caller remains responsible for closing the original descriptor.
  • packet_grace: default pause in the packet sending worker to allow another packet to be queued before flushing the output stream. Default: DEFAULT_PACKET_GRACEs. A value of 0 will flush immediately if the queue is empty.
  • request_handler: an optional callable accepting (rq_type, flags, payload). The request_handler may return one of 5 values on success:
    • None: response will be 0 flags and an empty payload.
    • int: flags only. Response will be the flags and an empty payload.
    • bytes: payload only. Response will be 0 flags and the payload.
    • str: payload only. Response will be 0 flags and the str encoded as bytes using UTF-8.
    • (int, bytes): Specify flags and payload for response. An unsuccessful request should raise an exception, which will cause a failure response packet.
  • tick: optional tick parameter, default None. If None, do nothing. If a Boolean, call tick_fd_2 if true, otherwise do nothing. Otherwise tick should be a callable accepting a byteslike value.

Method PacketConnection.do(self, *a, **kw)

Wrapper function to check that this instance is not closed.

Method PacketConnection.join(self)

Wait for the receive side of the connection to terminate.

Method PacketConnection.request(self, *a, **kw)

Wrapper function to check that this instance is not closed.

Method PacketConnection.shutdown(self, *a, **kw)

Shut down the PacketConnection, optionally blocking for outstanding requests.

Parameters: block: block for outstanding requests, default False.

Class Request_State(builtins.tuple)

RequestState(decode_response, result)

Property Request_State.decode_response

Alias for field number 0

Property Request_State.result

Alias for field number 1

Function tick_fd_2(bs)

A low level tick function to write a short binary tick to the standard error file descriptor.

This may be called by the send and receive workers to give an indication of activity type.

Release Log

Release 20211208:

  • Packet.eq: only test .rq_type if .is_request.
  • Update tests for changes.

Release 20210306:

  • Port to new cs.binary.Binary* classes.
  • Some refactors and small fixes.

Release 20191004:

  • PacketConnection: new optional parameter packet_grace to tune the send delay for additional packets before a flush, default DEFAULT_PACKET_GRACE (0.01s), 0 for no delay.
  • Add a crude packet level activity ticker.

Release 20190221: DISTINFO requirement updates.

Release 20181228: Initial PyPI release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cs.packetstream-20211208.tar.gz (10.0 kB view details)

Uploaded Source

File details

Details for the file cs.packetstream-20211208.tar.gz.

File metadata

  • Download URL: cs.packetstream-20211208.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.8

File hashes

Hashes for cs.packetstream-20211208.tar.gz
Algorithm Hash digest
SHA256 a8c8495ba9fb0c17e19da9b3b12c770bfcc1c8067afd89d021392e55beade0ff
MD5 049bb5521ca57bd4fda28d55fbcefea1
BLAKE2b-256 f7d06c7d9ba0388d5e8d36a09542a538914f7dbe576e284efad4fc0763ec02c9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page