puppetlabs.pcp.message-v1 — puppetlabs/pcp-common 1.3.6

ByteArray clj

Schema for a byte-array

bytes->string clj

(bytes->string bytes)

Returns a string given a byte-array

chunk-codec clj

conversion-charset clj

Charset used for the string <-> byte-array conversions

decode clj

(decode bytes)

Inputs: [bytes :- ByteArray] Returns: Message

Returns a message object from a network format message

decode-descriptor clj

(decode-descriptor byte)

Returns the clojure object for a chunk descriptor from a byte

descriptor-codec clj

encode clj

(encode message)

Inputs: [message :- Message] Returns: ByteArray

encode-descriptor clj

(encode-descriptor type)

Returns a binary representation of a chunk descriptor

filter-private clj deprecated

(filter-private message)

Deprecated, use message->envelope if you need

flag-bits clj

FlagSet clj

Schema for the message flags

get-data clj

(get-data message)

Inputs: [message :- Message] Returns: ByteArray

Returns the data from the data frame

get-debug clj

(get-debug message)

Inputs: [message :- Message] Returns: ByteArray

Returns the data from the debug frame

get-json-data clj

(get-json-data message)

Inputs: [message :- Message] Returns: s/Any

Returns the data from the data frame decoded from json

get-json-debug clj

(get-json-debug message)

Inputs: [message :- Message] Returns: s/Any

Returns the data from the debug frame decoded from json

length-codec clj

make-message clj

(make-message)

(make-message opts)

(make-message k v & kvs)

Inputs: ([] [k v & kvs] [opts]) Returns: Message

Returns a new empty message structure

Message clj

Defines the message objects we're using

message->envelope clj

(message->envelope message)

Inputs: [message :- Message] Returns: v1-Envelope

Returns the map without any of the known 'private' keys. Should map to an envelope schema.

message-codec clj

set-data clj

(set-data message data)

(set-data message data flags)

Inputs: ([message :- Message data :- ByteArray] [message :- Message data :- ByteArray flags :- FlagSet]) Returns: Message

Sets the data for the data frame

set-debug clj

(set-debug message data)

(set-debug message data flags)

Inputs: ([message :- Message data :- ByteArray] [message :- Message data :- ByteArray flags :- FlagSet]) Returns: Message

Sets the data for the debug frame

set-expiry clj

(set-expiry message timestamp)

(set-expiry message number unit)

Inputs: ([message :- Message number :- s/Int unit :- s/Keyword] [message :- Message timestamp :- ISO8601]) Returns: Message

Returns a message with new expiry

set-json-data clj

(set-json-data message data)

Inputs: [message :- Message data :- s/Any] Returns: Message

Sets the data to be the json byte-array version of data

set-json-debug clj

(set-json-debug message data)

Inputs: [message :- Message data :- s/Any] Returns: Message

Sets the debug data to be the json byte-array version of data

string->bytes clj

(string->bytes s)

Returns an array of bytes from a string