Class: OpenAI::Models::Responses::Connection

Inherits:
Object
  • Object
show all
Includes:
Enumerable[OpenAI::Models::Responses::connection_server_event]
Defined in:
sig/openai/helpers/responses_websocket/connection.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Connection

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Connection.

Parameters:

  • socket: (top)
  • url: (URI::Generic) 


19
 
# File 'sig/openai/helpers/responses_websocket/connection.rbs', line 19

def initialize: (socket: top, url: URI::Generic) -> void

Instance Attribute Details

#response ⇒ OpenAI::Responses::ConnectionResources::Response (readonly)

Returns the value of attribute response.

Returns:



16
17
18
 
# File 'sig/openai/helpers/responses_websocket/connection.rbs', line 16

def response
  @response
end

#url ⇒ URI::Generic (readonly)

Returns the value of attribute url.

Returns:

  • (URI::Generic) 


15
16
17
 
# File 'sig/openai/helpers/responses_websocket/connection.rbs', line 15

def url
  @url
end

Instance Method Details

#abort ⇒ nil

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (nil) 


40
 
# File 'sig/openai/helpers/responses_websocket/connection.rbs', line 40

def abort: -> nil

#close ⇒ nil

Parameters:

  • code: (Integer)
  • reason: (String)

Returns:

  • (nil) 


37
 
# File 'sig/openai/helpers/responses_websocket/connection.rbs', line 37

def close: (?code: Integer, ?reason: String) -> nil

#closed? ⇒ Boolean

Returns:



41
 
# File 'sig/openai/helpers/responses_websocket/connection.rbs', line 41

def closed?: -> bool

#each ⇒ void

This method returns an undefined value.



20
 
# File 'sig/openai/helpers/responses_websocket/connection.rbs', line 20

def each:

#poisoned? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:



44
 
# File 'sig/openai/helpers/responses_websocket/connection.rbs', line 44

def poisoned?: -> bool

#receive ⇒ OpenAI::Models::Responses::connection_server_event?

Returns:

  • (OpenAI::Models::Responses::connection_server_event, nil) 


25
 
# File 'sig/openai/helpers/responses_websocket/connection.rbs', line 25

def receive: -> OpenAI::Models::Responses::connection_server_event?

#receive_raw ⇒ String?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (String, nil) 


28
 
# File 'sig/openai/helpers/responses_websocket/connection.rbs', line 28

def receive_raw: -> String?

#send_event ⇒ Object 



30
 
# File 'sig/openai/helpers/responses_websocket/connection.rbs', line 30

def send_event: (

#send_raw ⇒ nil

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • data (String)

Returns:

  • (nil) 


35
 
# File 'sig/openai/helpers/responses_websocket/connection.rbs', line 35

def send_raw: (String data) -> nil