Class: RuntimeContext

Inherits:
AbstractRuntimeContext show all
Defined in:
lib/javonet-ruby-sdk/sdk/runtime_context.rb

Overview

Represents a single context which allows interaction with a selected technology. Refers to a single instance of the called runtime within a particular target OS process. This can be either the local currently running process (inMemory) or a particular remote process identified by the IP Address and PORT of the target Javonet instance. Multiple Runtime Contexts can be initialized within one process. Calling the same technology on inMemory communication channel will return the existing instance of runtime context. Calling the same technology on TCP channel but on different nodes will result in unique Runtime Contexts. Within the runtime context, any number of libraries can be loaded and any objects from the target technology can be interacted with, as they are aware of each other due to sharing the same memory space and same runtime instance.

See Also:

  • to this {https://www.javonet.com/guides/v2/ruby/foundations/runtime-context article on Javonet Guides}

Constant Summary collapse

@@memory_runtime_contexts = 
Hash.new
@@network_runtime_contexts = 
Hash.new
@@ws_runtime_contexts = 
Hash.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(runtime_name, connection_type, connection_data) ⇒ RuntimeContext

Returns a new instance of RuntimeContext.



30
31
32
33
34
35
36
 
# File 'lib/javonet-ruby-sdk/sdk/runtime_context.rb', line 30

def initialize(runtime_name, connection_type, connection_data)
  @runtime_name = runtime_name
  @connection_type = connection_type
  @connection_data = connection_data
  @current_command = nil
  SdkMessageHelper.send_message_to_app_insights("SdkMessage", RuntimeNameHandler.get_name(@runtime_name).capitalize + " initialized")
end

Instance Attribute Details

#connection_data ⇒ Object (readonly)

Returns the value of attribute connection_data.



25
26
27
 
# File 'lib/javonet-ruby-sdk/sdk/runtime_context.rb', line 25

def connection_data
  @connection_data
end

#current_command ⇒ Object

accessor get method



23
24
25
 
# File 'lib/javonet-ruby-sdk/sdk/runtime_context.rb', line 23

def current_command
  @current_command
end

#runtime_name ⇒ Object (readonly)

Returns the value of attribute runtime_name.



24
25
26
 
# File 'lib/javonet-ruby-sdk/sdk/runtime_context.rb', line 24

def runtime_name
  @runtime_name
end

Class Method Details

.get_instance(runtime_name, connection_type, connection_data) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/javonet-ruby-sdk/sdk/runtime_context.rb', line 38

def self.get_instance(runtime_name, connection_type, connection_data)
  case connection_type
  when ConnectionType::IN_MEMORY
    if @@memory_runtime_contexts.has_key?(runtime_name)
      runtime_ctx = @@memory_runtime_contexts[runtime_name]
      runtime_ctx.current_command = nil
      return runtime_ctx
    else
      runtime_ctx = RuntimeContext.new(runtime_name, connection_type, connection_data)
      @@memory_runtime_contexts[runtime_name] = runtime_ctx
      return runtime_ctx
    end
  when ConnectionType::TCP
    key = runtime_name.to_s + ":" + connection_data.to_s
    if @@network_runtime_contexts.has_key?(key)
      runtime_ctx = @@network_runtime_contexts[key]
      runtime_ctx.current_command = nil
      return runtime_ctx
    else
      runtime_ctx = RuntimeContext.new(runtime_name, connection_type, connection_data)
      @@network_runtime_contexts[key] = runtime_ctx
      return runtime_ctx
    end
  when ConnectionType::WEB_SOCKET
    key = runtime_name.to_s + ":" + connection_data.to_s
    if @@ws_runtime_contexts.has_key?(key)
      runtime_ctx = @@ws_runtime_contexts[key]
      runtime_ctx.current_command = nil
      return runtime_ctx
    else
      runtime_ctx = RuntimeContext.new(runtime_name, connection_type, connection_data)
      @@ws_runtime_contexts[key] = runtime_ctx
      return runtime_ctx
    end
  end
end

.initialize_runtime_context(config) ⇒ RuntimeContext

Initializes RuntimeContext based on the Config object and loads modules.

Parameters:

  • config (Config) —

    Instance of Config.

Returns:



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/javonet-ruby-sdk/sdk/runtime_context.rb', line 78

def self.initialize_runtime_context(config)
  # Determine connection type from connection_data
  connection_type = if config.connection_data.nil?
                      ConnectionType::IN_MEMORY
                    elsif config.connection_data.is_a?(TcpConnectionData)
                      ConnectionType::TCP
                    elsif config.connection_data.is_a?(WsConnectionData)
                      ConnectionType::WEB_SOCKET
                    else
                      ConnectionType::IN_MEMORY
                    end

  # Create runtime context using config's runtime and connection data
  rtm_ctx = RuntimeContext.get_instance(config.runtime, connection_type, config.connection_data)

  # Load modules if connection is InMemory
  if connection_type == ConnectionType::IN_MEMORY
    modules = config.modules
    if modules && !modules.strip.empty?
      modules.split(",").each do |module_path|
        trimmed = module_path.strip
        next if trimmed.empty?
        begin
          full_path = File.realpath(File.expand_path(trimmed))
          rtm_ctx.load_library(full_path)
        rescue => e
          raise "Error resolving path for module: #{trimmed}"
        end
      end
    end
  end

  rtm_ctx
end

Instance Method Details

#as_out(*args) ⇒ InvocationContext

Creates a reference type argument that can be passed to a method with an out parameter modifier. This method is used when working with methods from the called runtime that require arguments to be passed by reference. The arguments include the value and optionally the type of the reference. The type must be retrieved from the called runtime using the getType method. After creating the reference, it can be used as an argument when invoking methods.

Parameters:

  • args (Array) —

    The value and optionally the type of the reference.

Returns:

See Also:

  • to this {https://www.javonet.com/guides/v2/ruby/methods-arguments/passing-arguments-by-reference-with-out-keyword article on Javonet Guides}


200
201
202
203
204
 
# File 'lib/javonet-ruby-sdk/sdk/runtime_context.rb', line 200

def as_out(*args)
  local_command = Command.new(@runtime_name, CommandType::AS_OUT, [*args])
  @current_command = nil
  InvocationContext.new(@runtime_name, @connection_type, @connection_data, build_command(local_command), false)
end

#as_ref(*args) ⇒ InvocationContext

Creates a reference type argument that can be passed to a method with a ref parameter modifier. This method is used when working with methods from the called runtime that require arguments to be passed by reference. The arguments include the value and optionally the type of the reference. The type must be retrieved from the called runtime using the getType method. After creating the reference, it can be used as an argument when invoking methods.

Parameters:

  • args (Array) —

    The value and optionally the type of the reference.

Returns:

See Also:

  • to this {https://www.javonet.com/guides/v2/ruby/methods-arguments/passing-arguments-by-reference-with-ref-keyword article on Javonet Guides}


186
187
188
189
190
 
# File 'lib/javonet-ruby-sdk/sdk/runtime_context.rb', line 186

def as_ref(*args)
  local_command = Command.new(@runtime_name, CommandType::AS_REF, [*args])
  @current_command = nil
  InvocationContext.new(@runtime_name, @connection_type, @connection_data, build_command(local_command), false)
end

#build_command(command) ⇒ Object 



232
233
234
235
236
237
 
# File 'lib/javonet-ruby-sdk/sdk/runtime_context.rb', line 232

def build_command(command)
  command.payload.each_index { |i|
    command.payload[i] = encapsulate_payload_item(command.payload[i])
  }
  command.prepend_arg_to_payload(@current_command)
end

#cast(*args) ⇒ InvocationContext

Casts the provided value to a specific type. This method is used when invoking methods that require specific types of arguments. The arguments include the target type and the value to be cast. The target type must be retrieved from the called runtime using the getType method. After casting the value, it can be used as an argument when invoking methods. #see Refer to this article on Javonet Guides

Parameters:

  • args (Array) —

    The target type and the value to be cast.

Returns:



159
160
161
162
163
 
# File 'lib/javonet-ruby-sdk/sdk/runtime_context.rb', line 159

def cast(*args)
  local_command = Command.new(@runtime_name, CommandType::CAST, [*args])
  @current_command = nil
  InvocationContext.new(@runtime_name, @connection_type, @connection_data, build_command(local_command), false)
end

#encapsulate_payload_item(payload_item) ⇒ Object 



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/javonet-ruby-sdk/sdk/runtime_context.rb', line 239

def encapsulate_payload_item(payload_item)
  if payload_item.is_a? Command
    payload_item.payload.each_index { |i|
      payload_item.payload[i] = encapsulate_payload_item(payload_item.payload[i])
    }
    return payload_item

  elsif payload_item.is_a? InvocationContext
    return payload_item.current_command

  elsif payload_item.is_a? Array
    copied_array = payload_item.map { |item| encapsulate_payload_item(item) }
    return Command.new(@runtime_name, CommandType::ARRAY, copied_array)
  elsif TypesHandler.primitive_or_none?(payload_item)
    return Command.new(@runtime_name, CommandType::VALUE, payload_item.nil? ? [nil] : [*payload_item])
  else
    raise TypeError, "Unsupported payload item type: #{payload_item.class} for payload item: #{payload_item}."
  end
end

#execute ⇒ Object

Executes the current command. The initial state of RuntimeContext is non-materialized, wrapping either a single command or a chain of recursively nested commands. Commands become nested through each invocation of methods on RuntimeContext. Each invocation triggers the creation of a new RuntimeContext instance wrapping the current command with a new parent command. The developer can decide at any moment of the materialization for the context, taking full control of the chunks of the expression being transferred and processed on the target runtime.

See Also:

  • to this {https://www.javonet.com/guides/v2/ruby/foundations/execute-method article on Javonet Guides}


119
120
121
122
123
124
125
126
127
128
 
# File 'lib/javonet-ruby-sdk/sdk/runtime_context.rb', line 119

def execute
  @response_command = Interpreter.execute(@current_command, @connection_type, @connection_data)
  @current_command = nil

  if @response_command.command_type == CommandType::EXCEPTION
    exception = ExceptionThrower.throw_exception(@response_command)
    SdkMessageHelper.send_message_to_app_insights("SdkException", exception.message)
    raise exception
  end
end

#get_enum_item(*args) ⇒ InvocationContext

Retrieves a specific item from an enum type. This method is used when working with enums from the called runtime. The arguments include the enum type and the name of the item. The enum type must be retrieved from the called runtime using the getType method. After retrieving the item, it can be used as an argument when invoking methods.

Parameters:

  • args (Array) —

    The enum type and the name of the item.

Returns:

See Also:

  • to this {https://www.javonet.com/guides/v2/ruby/enums/using-enum-type article on Javonet Guides}


172
173
174
175
176
 
# File 'lib/javonet-ruby-sdk/sdk/runtime_context.rb', line 172

def get_enum_item(*args)
  local_command = Command.new(@runtime_name, CommandType::GET_ENUM_ITEM, [*args])
  @current_command = nil
  InvocationContext.new(@runtime_name, @connection_type, @connection_data, build_command(local_command), false)
end

#get_global_field(field_name) ⇒ InvocationContext

Retrieves the value of a global field from the called runtime. The argument includes the global field name. After retrieving the field, the result can be used for further operations.

Parameters:

  • field_name (String) —

    The name of the global field to retrieve.

Returns:

  • (InvocationContext) —

    The InvocationContext instance that wraps the command to get the global field.

See Also:

  • to this {https://www.javonet.com/guides/v2/ruby/fields-and-properties/getting-values-for-global-fields article on Javonet Guides}


225
226
227
228
229
 
# File 'lib/javonet-ruby-sdk/sdk/runtime_context.rb', line 225

def get_global_field(field_name)
  local_command = Command.new(@runtime_name, CommandType::GET_GLOBAL_FIELD, [field_name])
  @current_command = nil
  InvocationContext.new(@runtime_name, @connection_type, @connection_data, build_command(local_command), false)
end

#get_type(*args) ⇒ InvocationContext

Retrieves a reference to a specific type. The type can be a class, interface or enum. The type can be retrieved from any referenced library.

Parameters:

  • args (Array) —

    The full name of the type.

Returns:



147
148
149
150
151
 
# File 'lib/javonet-ruby-sdk/sdk/runtime_context.rb', line 147

def get_type(*args)
  local_command = Command.new(@runtime_name, CommandType::GET_TYPE, [*args])
  @current_command = nil
  InvocationContext.new(@runtime_name, @connection_type, @connection_data, build_command(local_command), false)
end

#invoke_global_function(function_name, *args) ⇒ InvocationContext

Invokes a function from the called runtime. This method is used when working with functions from the called runtime. The arguments include the function name and the arguments to be passed to the function. After invoking the function, the result can be used for further operations.

Parameters:

  • function_name (String) —

    The name of the function to invoke.

  • args (Array) —

    The arguments to be passed to the function.

Returns:

  • (InvocationContext) —

    The InvocationContext instance that wraps the command to invoke the function.

See Also:

  • to this {https://www.javonet.com/guides/v2/ruby/functions/invoking-functions article on Javonet Guides}


213
214
215
216
217
 
# File 'lib/javonet-ruby-sdk/sdk/runtime_context.rb', line 213

def invoke_global_function(function_name, *args)
  local_command = Command.new(@runtime_name, CommandType::INVOKE_GLOBAL_FUNCTION, [function_name, *args])
  @current_command = nil
  InvocationContext.new(@runtime_name, @connection_type, @connection_data, build_command(local_command), false)
end

#load_library(*args) ⇒ RuntimeContext

Adds a reference to a library. Javonet allows you to reference and use modules or packages written in various languages. This method allows you to use any library from all supported technologies. The necessary libraries need to be referenced. The argument is a relative or full path to the library. If the library has dependencies on other libraries, the latter needs to be added first. After referencing the library, any objects stored in this package can be used. Use static classes, create instances, call methods, use fields and properties, and much more.

Parameters:

  • args (Array) —

    The relative or full path to the library.

Returns:

See Also:

  • to this {https://www.javonet.com/guides/v2/ruby/getting-started/adding-references-to-libraries article on Javonet Guides}


137
138
139
140
141
142
 
# File 'lib/javonet-ruby-sdk/sdk/runtime_context.rb', line 137

def load_library(*args)
  local_command = Command.new(@runtime_name, CommandType::LOAD_LIBRARY, [*args])
  @current_command = build_command(local_command)
  self.execute
  self
end