Liking cljdoc? Tell your friends :D

aleph.netty


acquireclj

(acquire x)

Increases the reference count by 1.

Increases the reference count by 1.
sourceraw docstring

AlephServercljprotocol

portclj

(port _)

Returns the port the server is listening on.

Returns the port the server is listening on.

wait-for-closeclj

(wait-for-close _)

Blocks until the server has been closed.

Blocks until the server has been closed.
source

append-handler-to-pipelineclj

(append-handler-to-pipeline pipeline handler-id handler)

Convenience function to add a handler to the tail of a netty pipeline.

Convenience function to add a handler to the tail of a netty pipeline.
sourceraw docstring

append-to-buf!clj

(append-to-buf! buf x)

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

Appends `x` to an existing `io.netty.buffer.ByteBuf`.
sourceraw docstring

dns-resolver-groupclj

(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.

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`.
sourceraw docstring

dns-resolver-group-builderclj

(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 keyDescription
max-payload-sizesets capacity of the datagram packet buffer (in bytes), defaults to 4096
max-queries-per-resolvesets the maximum allowed number of DNS queries to send when resolving a host name, defaults to 16
address-typessets 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-timeoutsets the timeout of each DNS query performed by this resolver (in milliseconds), defaults to 5000
min-ttlsets minimum TTL of the cached DNS resource records (in seconds), defaults to 0
max-ttlsets 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-ttlsets 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-domainssets the list of search domains of the resolver, when not given the default list is used (platform dependent)
ndotssets 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-serversoptional list of DNS server addresses, automatically discovered when not set (platform dependent)
transportthe transport to use, one of :nio, :epoll, :kqueue or :io-uring (defaults to :nio)
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`)
sourceraw docstring

insecure-ssl-client-contextclj

(insecure-ssl-client-context)

An insure SSL context for servers.

An insure SSL context for servers.
sourceraw docstring

pipeline-initializerclj

(pipeline-initializer pipeline-builder)
source

prepend-handler-to-pipelineclj

(prepend-handler-to-pipeline pipeline handler-id handler)

Convenience function to add a handler to the head of a netty pipeline.

Convenience function to add a handler to the head of a netty pipeline.
sourceraw docstring

releaseclj

(release x)

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

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

remove-if-presentclj

(remove-if-present pipeline handler)

Convenience function to remove a handler from a netty pipeline.

Convenience function to remove a handler from a netty pipeline.
sourceraw docstring

self-signed-ssl-contextclj

(self-signed-ssl-context)

A self-signed SSL context for servers.

A self-signed SSL context for servers.
sourceraw docstring

set-logger!clj

(set-logger! logger)

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

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

ssl-client-contextclj

(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]})

Creates a new client SSL context. Keyword arguments are:

Param keyDescription
private-keya java.io.File, java.io.InputStream, or java.security.PrivateKey containing the client-side private key.
certificate-chaina 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-passworda string, the private key's password (optional).
trust-storea 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-providerSslContext 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.
ciphersa sequence of strings, the cipher suites to enable, in the order of preference.
protocolsa sequence of strings, the TLS protocol versions to enable.
session-cache-sizethe size of the cache used for storing SSL session objects.
session-timeoutthe timeout for the cached SSL session objects, in seconds.

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.

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, 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.
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.
sourceraw docstring

ssl-server-contextclj

(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]})

Creates a new server SSL context. Keyword arguments are:

Param keyDescription
private-keya java.io.File, java.io.InputStream, or java.security.PrivateKey containing the server-side private key.
certificate-chaina java.io.File, java.io.InputStream, or array of java.security.cert.X509Certificate containing the server's certificate chain.
private-key-passworda string, the private key's password (optional).
trust-storea 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-providerSslContext 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.
ciphersa sequence of strings, the cipher suites to enable, in the order of preference.
protocolsa sequence of strings, the TLS protocol versions to enable.
session-cache-sizethe size of the cache used for storing SSL session objects.
session-timeoutthe timeout for the cached SSL session objects, in seconds.
start-tlsif the first write request shouldn't be encrypted.
client-auththe client authentication mode, one of :none, :optional or :require.

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.

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`.

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.
sourceraw docstring

to-byte-bufclj

(to-byte-buf x)
(to-byte-buf ch x)

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

Converts `x` into a `io.netty.buffer.ByteBuf`.
sourceraw docstring

to-byte-buf-streamclj

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

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

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

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close