puppetlabs.pcp.client — puppetlabs/pcp-client 2.1.0

-close clj

(-close client)

Inputs: [client :- Client] Returns: s/Bool

Close the connection. Prevent any reconnection attempt 1) by the concurrent 'connect' task, in case it's still executing, (NB: the 'connect' function operates asynchronously by invoking 'make-connection' in a separate thread) or 2) by the :on-close event handler. Stop the heartbeat thread.

-make-connection clj

(-make-connection client)

Inputs: [client :- Client] Returns: Session

Returns a connected org.eclipse.jetty.websocket.api.Session. In case of a SSLHandShakeException or ConnectException a further connection attempt will be made by following an exponential backoff, whereas other exceptions will be propagated.

-wait-for-connection clj

(-wait-for-connection client timeout)

Inputs: [client :- Client timeout :- s/Num] Returns: (s/maybe Client)

Waits until a client is connected. If timeout is hit, returns falsey

ClientInterface clj protocol

client interface - make one with connect

close clj

(close client)

Close the connection. Once the client is close you will need a new one.

NOTE: you must invoke this function to properly close the connection, otherwise reconnection attempts may happen and the heartbeat thread will persist, in case it was previously started.

connected? clj

(connected? client)

Returns true if the client is currently connected to the pcp-broker. Propagates any unhandled exception thrown while attempting to connect.

connecting? clj

(connecting? client)

Returns true if the client is currently connecting to the pcp-broker

send! clj

(send! client message)

Send a message across the currently connected client. Will raise ::not-associated if the client is not currently associated with the pcp-broker, and ::not-connected if the client has become disconnected from the pcp-broker.

wait-for-connection clj

(wait-for-connection client timeout-ms)

Wait up to timeout-ms for a connection to be established. Returns the client if the connection has been established, else nil. Propagates any unhandled exception thrown while attempting to connect.

connect clj

(connect params handlers)

Inputs: [params :- ConnectParams handlers :- Handlers] Returns: Client

Asyncronously establishes a connection to a pcp-broker named by :server. Returns a Client.

The certificate file specified can provide either a single certificate, or a certificate chain (with the first entry being the client's certificate).

ConnectParams clj

schema for connection parameters

create-websocket-session clj

(create-websocket-session websocket-client client-endpoint request-path-uri)

Inputs: [websocket-client client-endpoint request-path-uri] Returns: Session

get-ssl-context clj multimethod

Handlers clj

schema for handler map. String keys are data_schema handlers, keyword keys are special handlers (like :default)

make-ssl-context clj

(make-ssl-context params)

Inputs: [params] Returns: SslContextFactory$Client

Returns an SslContextFactory$Client that does client authentication based on the client certificate named.

make-websocket-client clj

(make-websocket-client ssl-context max-message-size)

Inputs: [ssl-context :- SslContextFactory$Client max-message-size :- (s/maybe s/Int)] Returns: WebSocketClient

Returns a WebSocketClient with the correct SSL context.

map->Client clj

(map->Client m9371)

Factory function for class Client, taking a map of keywords to field values, but not much slower than ->x like the clojure.core version. (performance is fixed in Clojure 1.7, so this should eventually be removed.)

SslFiles clj

strict-map->Client clj

(strict-map->Client m9372 & [drop-extra-keys?__4873__auto__])

Factory function for class Client, taking a map of keywords to field values. All keys are required, and no extra keys are allowed. Even faster than map->