Allows to take over transport of message communication initiated by an instrument. Implement this interface to provide a transport of message communication. When an instrument is about to create a server endpoint, it calls the MessageTransport#open(URI, MessageEndpoint) method with the server URI.

Usage example: MessageTransportSnippets#example

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	MessageTransport.VetoException Thrown when a transport connection is vetoed.

Method Summary

Modifier and Type	Method and Description
public MessageEndpoint	Returns: an implementation of `MessageEndpoint` call back, or `null`. open(URI the connection URI uri, MessageEndpoint the peer endpoint representation peerEndpoint) Called when a connection to an URI is to be established.

Method Detail

open back to summary

open	back to summary
public MessageEndpoint open(URI uri, MessageEndpoint peerEndpoint) throws IOException, VetoException Called when a connection to an URI is to be established. The virtualized connection is either opened and an endpoint call back is returned, or the connection is not virtualized in which case `null` is returned. This method can be called concurrently from multiple threads. However, the `MessageEndpoint` ought to be called on one thread at a time, unless you're sure that the particular implementation can handle concurrent calls. The same holds true for the returned endpoint, it's called synchronously. Parameters uri:URI the connection URI peerEndpoint:MessageEndpoint the peer endpoint representation Returns:MessageEndpoint an implementation of `MessageEndpoint` call back, or `null`. Exceptions VetoException: to veto connection to the URL. Since 19.0

public MessageEndpoint open(URI uri, MessageEndpoint peerEndpoint) throws IOException, VetoException

Called when a connection to an URI is to be established. The virtualized connection is either opened and an endpoint call back is returned, or the connection is not virtualized in which case null is returned.

This method can be called concurrently from multiple threads. However, the MessageEndpoint ought to be called on one thread at a time, unless you're sure that the particular implementation can handle concurrent calls. The same holds true for the returned endpoint, it's called synchronously.

Parameters

uri:URI: the connection URI
peerEndpoint:MessageEndpoint: the peer endpoint representation

Returns:MessageEndpoint

an implementation of MessageEndpoint call back, or null.

Exceptions

VetoException:: to veto connection to the URL.

Since

19.0

org.graalvm.polyglot.io back to summary

public final Class MessageTransport.VetoException

Class Inheritance

extends Exception

java.lang.Object
java.lang.Throwable
java.lang.Exception
org.graalvm.polyglot.io.MessageTransport.VetoException

Thrown when a transport connection is vetoed. The initiator of the connection is obliged to abandon it when this exception is thrown.

Since: 19.0

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides java.lang.Exception.serialVersionUID.

Constructor Summary

Access	Constructor and Description
public	VetoException(String message) Create a new VetoException.

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.lang.Exception.serialVersionUID.

Constructor Detail

VetoException	back to summary
public VetoException(String message) Create a new VetoException. Since 19.0

VetoException

back to summary

public VetoException(String message)

Create a new VetoException.

Since: 19.0

public Interface MessageTransport