aleph.netty — aleph 0.8.3

->application-protocol-name clj

acquire clj

(acquire x)

Increases the reference count by 1.

add-idle-handlers clj

(add-idle-handlers pipeline idle-timeout)

AlephServer clj protocol

port clj

(port _)

Returns the port the server is listening on.

wait-for-close clj

(wait-for-close _)

Blocks until the server has been closed.

append-to-buf! clj

(append-to-buf! buf x)

Appends x to an existing io.netty.buffer.ByteBuf.

application-protocol-config clj

(application-protocol-config protocols)

Creates a default config for Application-Layer Protocol Negotiation (ALPN), which TLS uses to negotiate which HTTP version to use during the handshake.

Takes a vector of HTTP versions, in order of preference. E.g., [:http2 :http1]

Note that the returned config uses SelectorFailureBehavior.NO_ADVERTISE[1] and SelectedListenerFailureBehavior.ACCEPT[2] since these are the only failure behaviors supported by all SSL providers. See their documentation for details. One important consequence of this is that it's not possible to completely opt out of HTTP/1.1 by way of only specifying [:http2]. If you want this behavior and you know your SSL provider supports it, you can construct an ApplicationProtocolConfig with the desired settings yourself.

1: https://netty.io/4.1/api/io/netty/handler/ssl/ApplicationProtocolConfig.SelectorFailureBehavior.html#NO_ADVERTISE 2: https://netty.io/4.1/api/io/netty/handler/ssl/ApplicationProtocolConfig.SelectedListenerFailureBehavior.html#ACCEPT

close-on-idle-handler clj

(close-on-idle-handler)

default-connect-timeout clj

Netty's default connect timeout in milliseconds.

default-shutdown-timeout clj

Netty's default timeout in seconds to wait for graceful shutdown complete

dns-resolver-group clj

(dns-resolver-group dns-options)

Creates an instance of DnsAddressResolverGroup that might be set as a resolver to Bootstrap. The supported options are the same as to dns-resolver-group-builder.

dns-resolver-group-builder clj

(dns-resolver-group-builder
  {:keys [max-payload-size max-queries-per-resolve address-types query-timeout
          min-ttl max-ttl negative-ttl trace-enabled? opt-resources-enabled?
          search-domains ndots decode-idn? recursion-desired? name-servers
          epoll? transport]
   :or {recursion-desired? true
        max-payload-size 4096
        opt-resources-enabled? true
        max-ttl Integer/MAX_VALUE
        max-queries-per-resolve 16
        ndots -1
        epoll? false
        min-ttl 0
        decode-idn? true
        query-timeout 5000
        trace-enabled? false}})

Creates an instance of DnsAddressResolverGroupBuilder that is used to configure and initialize an DnsAddressResolverGroup instance.

DNS options are a map of:

Param key	Description
max-payload-size	sets capacity of the datagram packet buffer (in bytes), defaults to 4096
max-queries-per-resolve	sets the maximum allowed number of DNS queries to send when resolving a host name, defaults to 16
address-types	sets the list of the protocol families of the address resolved, should be one of :ipv4-only, :ipv4-preferred, :ipv6-only, :ipv4-preferred (calculated automatically based on ipv4/ipv6 support when not set explicitly)
query-timeout	sets the timeout of each DNS query performed by this resolver (in milliseconds), defaults to 5000
min-ttl	sets minimum TTL of the cached DNS resource records (in seconds), defaults to 0
max-ttl	sets maximum TTL of the cached DNS resource records (in seconds), defaults to Integer/MAX_VALUE (the resolver will respect the TTL from the DNS)
negative-ttl	sets the TTL of the cache for the failed DNS queries (in seconds)
trace-enabled?	if set to true, the resolver generates the detailed trace information in an exception message, defaults to false
opt-resources-enabled?	if set to true, enables the automatic inclusion of a optional records that tries to give the remote DNS server a hint about how much data the resolver can read per response, defaults to true
search-domains	sets the list of search domains of the resolver, when not given the default list is used (platform dependent)
ndots	sets the number of dots which must appear in a name before an initial absolute query is made, defaults to -1
decode-idn?	set if domain / host names should be decoded to unicode when received, defaults to true
recursion-desired?	if set to true, the resolver sends a DNS query with the RD (recursion desired) flag set, defaults to true
name-servers	optional list of DNS server addresses, automatically discovered when not set (platform dependent)
transport	the transport to use, one of :nio, :epoll, :kqueue or :io-uring (defaults to :nio)

insecure-ssl-client-context clj

(insecure-ssl-client-context)

(insecure-ssl-client-context opts)

An insecure client SSL context.

pipeline-initializer clj

(pipeline-initializer pipeline-builder)

Returns a ChannelInitializer which builds the pipeline.

pipeline-builder is a 1-ary fn that takes a ChannelPipeline and configures it.

release clj

(release x)

Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.

remove-if-present clj

(remove-if-present pipeline handler)

Convenience function to remove a handler from a netty pipeline.

self-signed-ssl-context clj

(self-signed-ssl-context)

(self-signed-ssl-context hostname)

(self-signed-ssl-context hostname opts)

A self-signed SSL context for servers.

Never use in production. Even if you control all clients, and want to use a self-signed cert internally, do not use this fn, because Netty's SelfSignedCertificate class is only for testing, and uses an insecure PRNG.

set-logger! clj

(set-logger! logger)

Changes the default logger factory. The parameter can be either :log4j, :log4j2, :slf4j or :jdk.

ssl-client-context clj

(ssl-client-context)

(ssl-client-context {:keys [private-key private-key-password certificate-chain
                            trust-store ssl-provider ciphers protocols
                            session-cache-size session-timeout
                            application-protocol-config]})

Creates a new client SSL context. Keyword arguments are:

Param key	Description
private-key	A java.io.File, java.io.InputStream, or java.security.PrivateKey containing the client-side private key.
certificate-chain	A java.io.File, java.io.InputStream, sequence of java.security.cert.X509Certificate, or array of java.security.cert.X509Certificate containing the client's certificate chain.
private-key-password	A string, the private key's password (optional).
trust-store	A java.io.File, java.io.InputStream, array of java.security.cert.X509Certificate, javax.net.ssl.TrustManager, or a javax.net.ssl.TrustManagerFactory to initialize the context's trust manager.
ssl-provider	SslContext implementation to use, one of :jdk, :openssl or :openssl-refcnt. Note, that when using OpenSSL-based implementations, the library should be installed and linked properly.
ciphers	A sequence of strings, the cipher suites to enable, in the order of preference.
protocols	A sequence of strings, the TLS protocol versions to enable.
session-cache-size	The size of the cache used for storing SSL session objects.
session-timeout	The timeout for the cached SSL session objects, in seconds.
application-protocol-config	An ApplicationProtocolConfig instance to configure ALPN. See the application-protocol-config function.

Note that if specified, the types of private-key and certificate-chain must be compatible: either both input streams, both files, or a private key and an array of certificates.

ssl-handler clj

(ssl-handler ch ssl-ctx)

(ssl-handler ch ssl-ctx remote-address)

(ssl-handler ch ssl-ctx remote-address ssl-endpoint-id-alg)

Generates a new SslHandler for the given SslContext.

The 2-ary version is for servers.

The 3- and 4-ary versions are for clients. For these, the remote-address must be provided.

The ssl-endpoint-id-alg is the name of the algorithm to use for endpoint identification (see https://docs.oracle.com/en/java/javase/17/docs/specs/security/standard-names.html#endpoint-identification-algorithms). It defaults to "HTTPS" in the 3-ary version which is a reasonable default for non-HTTPS uses, too. Pass nil to disable endpoint identification.

ssl-server-context clj

(ssl-server-context)

(ssl-server-context {:keys [private-key private-key-password certificate-chain
                            trust-store ssl-provider ciphers protocols
                            session-cache-size session-timeout start-tls
                            client-auth application-protocol-config]})

Creates a new server SSL context. Keyword arguments are:

Param key	Description
private-key	A java.io.File, java.io.InputStream, or java.security.PrivateKey containing the server-side private key.
certificate-chain	A java.io.File, java.io.InputStream, or array of java.security.cert.X509Certificate containing the server's certificate chain.
private-key-password	A string, the private key's password (optional).
trust-store	A java.io.File, java.io.InputStream, sequence of java.security.cert.X509Certificate, array of java.security.cert.X509Certificate, javax.net.ssl.TrustManager, or a javax.net.ssl.TrustManagerFactory to initialize the context's trust manager.
ssl-provider	SslContext implementation to use, on of :jdk, :openssl or :openssl-refcnt. Note, that when using OpenSSL based implementations, the library should be installed and linked properly.
ciphers	A sequence of strings, the cipher suites to enable, in the order of preference.
protocols	A sequence of strings, the TLS protocol versions to enable.
session-cache-size	The size of the cache used for storing SSL session objects.
session-timeout	The timeout for the cached SSL session objects, in seconds.
start-tls	If the first write request shouldn't be encrypted.
client-auth	The client authentication mode, one of :none, :optional or :require.
application-protocol-config	An ApplicationProtocolConfig instance to configure ALPN. See the application-protocol-config function.`

Note that if specified, the types of private-key and certificate-chain must be "compatible": either both input streams, both files, or a private key and an array of certificates.

to-byte-buf clj

(to-byte-buf x)

(to-byte-buf ch x)

Converts x into a io.netty.buffer.ByteBuf.

to-byte-buf-stream clj

(to-byte-buf-stream x chunk-size)

Converts x into a manifold stream of io.netty.ByteBuf of chunk-size.