Class: Temporalio::Client::Connection

Inherits:
Object
  • Object
show all
Defined in:
lib/temporalio/client/connection.rb,
lib/temporalio/client/connection/service.rb,
lib/temporalio/client/connection/test_service.rb,
lib/temporalio/client/connection/cloud_service.rb,
lib/temporalio/client/connection/operator_service.rb,
lib/temporalio/client/connection/workflow_service.rb

Overview

Connection to Temporal server that is not namespace specific. Most users will use connect instead of this directly.

Defined Under Namespace

Classes: CloudService, HTTPConnectProxyOptions, KeepAliveOptions, OperatorService, Options, RPCRetryOptions, Service, TLSOptions, TestService, WorkflowService

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(target_host:, api_key: nil, tls: false, rpc_metadata: {}, rpc_retry: RPCRetryOptions.new, identity: "#{Process.pid}@#{Socket.gethostname}", keep_alive: KeepAliveOptions.new, http_connect_proxy: nil, runtime: Runtime.default, lazy_connect: false) ⇒ Connection

Connect to Temporal server. Most users will use Temporalio::Client.connect instead of this directly. Parameters here match Options returned from #options by intention so options can be dup’d, altered, splatted to create a new connection.

Parameters:

  • target_host (String) —

    host:port for the Temporal server. For local development, this is often localhost:7233.

  • api_key (String, nil) (defaults to: nil) —

    API key for Temporal. This becomes the Authorization HTTP header with “Bearer ” prepended. This is only set if RPC metadata doesn’t already have an authorization key.

  • tls (Boolean, TLSOptions) (defaults to: false) —

    If false, do not use TLS. If true, use system default TLS options. If TLS options are present, those TLS options will be used.

  • rpc_metadata (Hash<String, String>) (defaults to: {}) —

    Headers to use for all calls to the server. Keys here can be overriden by per-call RPC metadata keys.

  • rpc_retry (RPCRetryOptions) (defaults to: RPCRetryOptions.new) —

    Retry options for direct service calls (when opted in) or all high-level calls made by this client (which all opt-in to retries by default).

  • identity (String) (defaults to: "#{Process.pid}@#{Socket.gethostname}") —

    Identity for this client.

  • keep_alive (KeepAliveOptions) (defaults to: KeepAliveOptions.new) —

    Keep-alive options for the client connection. Can be set to nil to disable.

  • http_connect_proxy (HTTPConnectProxyOptions, nil) (defaults to: nil) —

    Options for HTTP CONNECT proxy.

  • runtime (Runtime) (defaults to: Runtime.default) —

    Runtime for this client.

  • lazy_connect (Boolean) (defaults to: false) —

    If true, there is no connection until the first call is attempted or a worker is created with it. Clients from lazy connections cannot be used for workers if they have not performed a connection.

See Also:



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/temporalio/client/connection.rb', line 172

def initialize(
  target_host:,
  api_key: nil,
  tls: false,
  rpc_metadata: {},
  rpc_retry: RPCRetryOptions.new,
  identity: "#{Process.pid}@#{Socket.gethostname}",
  keep_alive: KeepAliveOptions.new,
  http_connect_proxy: nil,
  runtime: Runtime.default,
  lazy_connect: false
)
  @options = Options.new(
    target_host:,
    api_key:,
    tls:,
    rpc_metadata:,
    rpc_retry:,
    identity:,
    keep_alive:,
    http_connect_proxy:,
    runtime:,
    lazy_connect:
  ).freeze
  # Create core client now if not lazy
  @core_client_mutex = Mutex.new
  _core_client unless lazy_connect
  # Create service instances
  @workflow_service = WorkflowService.new(self)
  @operator_service = OperatorService.new(self)
  @cloud_service = CloudService.new(self)
end

Instance Attribute Details

#cloud_service ⇒ CloudService (readonly)

Returns Raw gRPC cloud service.

Returns:



146
147
148
 
# File 'lib/temporalio/client/connection.rb', line 146

def cloud_service
  @cloud_service
end

#operator_service ⇒ OperatorService (readonly)

Returns Raw gRPC operator service.

Returns:



143
144
145
 
# File 'lib/temporalio/client/connection.rb', line 143

def operator_service
  @operator_service
end

#options ⇒ Options (readonly)

Returns Frozen options for this client which has the same attributes as #initialize. Note that if #api_key= or #rpc_metadata= are updated, the options object is replaced with those changes (it is not mutated in place).

Returns:

  • (Options) —

    Frozen options for this client which has the same attributes as #initialize. Note that if #api_key= or #rpc_metadata= are updated, the options object is replaced with those changes (it is not mutated in place).



137
138
139
 
# File 'lib/temporalio/client/connection.rb', line 137

def options
  @options
end

#workflow_service ⇒ WorkflowService (readonly)

Returns Raw gRPC workflow service.

Returns:



140
141
142
 
# File 'lib/temporalio/client/connection.rb', line 140

def workflow_service
  @workflow_service
end

Instance Method Details

#api_key ⇒ String?

Returns API key. This is a shortcut for ‘options.api_key`.

Returns:

  • (String, nil) —

    API key. This is a shortcut for ‘options.api_key`.



222
223
224
 
# File 'lib/temporalio/client/connection.rb', line 222

def api_key
  @options.api_key
end

#api_key=(new_key) ⇒ Object

Set the API key for all future calls. This also makes a new object for #options with the changes.

Parameters:

  • new_key (String, nil) —

    New API key.



229
230
231
232
233
234
235
 
# File 'lib/temporalio/client/connection.rb', line 229

def api_key=(new_key)
  # Mutate the client if connected then mutate options
  @core_client_mutex.synchronize do
    @core_client&.update_api_key(new_key)
    @options = @options.with(api_key: new_key)
  end
end

#connected? ⇒ Boolean

Returns Whether this connection is connected. This is always ‘true` unless `lazy_connect` option was originally set, in which case this will be `false` until the first call is made.

Returns:

  • (Boolean) —

    Whether this connection is connected. This is always ‘true` unless `lazy_connect` option was originally set, in which case this will be `false` until the first call is made.



217
218
219
 
# File 'lib/temporalio/client/connection.rb', line 217

def connected?
  !@core_client.nil?
end

#identity ⇒ String

Returns Client identity.

Returns:

  • (String) —

    Client identity.



211
212
213
 
# File 'lib/temporalio/client/connection.rb', line 211

def identity
  @options.identity
end

#rpc_metadata ⇒ Hash<String, String>

Returns RPC metadata (aka HTTP headers). This is a shortcut for ‘options.rpc_metadata`.

Returns:

  • (Hash<String, String>) —

    RPC metadata (aka HTTP headers). This is a shortcut for ‘options.rpc_metadata`.



238
239
240
 
# File 'lib/temporalio/client/connection.rb', line 238

def rpc_metadata
  @options.rpc_metadata
end

#rpc_metadata=(rpc_metadata) ⇒ Object

Set the RPC metadata (aka HTTP headers) for all future calls. This also makes a new object for #options with the changes.

Parameters:

  • rpc_metadata (Hash<String, String>) —

    New API key.



246
247
248
249
250
251
252
 
# File 'lib/temporalio/client/connection.rb', line 246

def rpc_metadata=(rpc_metadata)
  # Mutate the client if connected then mutate options
  @core_client_mutex.synchronize do
    @core_client&.update_metadata(rpc_metadata)
    @options = @options.with(rpc_metadata: rpc_metadata)
  end
end

#target_host ⇒ String

Returns Target host this connection is connected to.

Returns:

  • (String) —

    Target host this connection is connected to.



206
207
208
 
# File 'lib/temporalio/client/connection.rb', line 206

def target_host
  @options.target_host
end