Class CopilotWebSocketForwarder

java.lang.Object

com.github.copilot.CopilotWebSocketHandler

com.github.copilot.CopilotWebSocketForwarder

All Implemented Interfaces:

AutoCloseable

public class CopilotWebSocketForwarder
extends CopilotWebSocketHandler

The default pass-through CopilotWebSocketHandler: it dials the real upstream using WebSocket and relays upstream-to-runtime messages into the runtime response unchanged.

Subclass and override sendRequestMessage(CopilotWebSocketMessage) or CopilotWebSocketHandler.sendResponseMessage(CopilotWebSocketMessage) (calling super) to observe, transform, or drop messages in either direction.

Since:

1.0.0

Field Summary

Fields inherited from class CopilotWebSocketHandler

context

Constructor Summary

Constructors

Constructor	Description
CopilotWebSocketForwarder(CopilotRequestContext context)	Creates a forwarding handler targeting the request URL and headers from context.

Method Summary

Modifier and Type	Method	Description
void	close(CopilotWebSocketCloseStatus status)	Closes the connection and finalises the runtime-facing response.
void	sendRequestMessage(CopilotWebSocketMessage message)	Sends a message from the runtime to the upstream connection.

Methods inherited from class CopilotWebSocketHandler

close, sendResponseMessage

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CopilotWebSocketForwarder

public CopilotWebSocketForwarder(CopilotRequestContext context)

Creates a forwarding handler targeting the request URL and headers from context.

Parameters:

context - the per-request context

Method Details

sendRequestMessage

public void sendRequestMessage(CopilotWebSocketMessage message)
                        throws Exception

Description copied from class: CopilotWebSocketHandler

Sends a message from the runtime to the upstream connection.

Specified by:

sendRequestMessage in class CopilotWebSocketHandler

Parameters:

message - the message to forward upstream

Throws:

Exception - if the message could not be forwarded

close

public void close(CopilotWebSocketCloseStatus status)
           throws Exception

Description copied from class: CopilotWebSocketHandler

Closes the connection and finalises the runtime-facing response. Idempotent.

Overrides:

close in class CopilotWebSocketHandler

Parameters:

status - the terminal status; a non-null CopilotWebSocketCloseStatus.error() surfaces a transport failure, otherwise a clean end-of-stream

Throws:

Exception - if the terminal frame could not be delivered