VertexCacheSdk.Model.ClientOption (vertexcache_sdk v1.0.0)

View Source

Configuration container for initializing the VertexCache SDK client.

This struct holds all user-specified options required to establish a connection to a VertexCache server, including host, port, TLS settings, authentication tokens, encryption modes (asymmetric or symmetric), and related keys or certificates.

It provides a flexible way to customize client behavior, including security preferences.

Summary

Functions

Returns the IDENT command used to initiate a client handshake.

Functions

build_ident_command(client_option)

@spec build_ident_command(%VertexCacheSdk.Model.ClientOption{
  client_id: term(),
  client_token: term(),
  connect_timeout: term(),
  enable_tls_encryption: term(),
  encrypt_with_public_key: term(),
  encrypt_with_shared_key: term(),
  encryption_mode: term(),
  public_key: term(),
  read_timeout: term(),
  server_host: term(),
  server_port: term(),
  shared_encryption_key: term(),
  tls_certificate: term(),
  verify_certificate: term()
}) :: String.t()

Returns the IDENT command used to initiate a client handshake.