JabRef 6.0-beta.1 · org.jabref.logic.remote.Protocol

Implementation Note

The first byte of every message identifies its type as a RemoteMessage. Every message is terminated with '\0'.

Field Summary

Modifier and Type	Field and Description
public static final String	IDENTIFIER
private final ObjectInputStream	in
private static final Logger	LOGGER
private final ObjectOutputStream	out
private final Socket	socket

Constructor Summary

Access	Constructor and Description
public	Protocol(Socket socket)
public	Protocol(Socket the connection to communicate over; only its output stream is used socket, InputStream the stream to read requests from — a wrapper around the socket's input stream that supports non-destructive probing, restored to the start of the request inputStream) Creates a protocol using a previously inspected input stream.

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.lang.AutoCloseable.close. Closes this resource, relinquishing any underlying resources.
public Pair<RemoteMessage, Object>	receiveMessage()
public void	sendMessage(RemoteMessage type)
public void	sendMessage(RemoteMessage type, Object argument)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

IDENTIFIER	back to summary
public static final String IDENTIFIER

in	back to summary
private final ObjectInputStream in

LOGGER	back to summary
private static final Logger LOGGER

out	back to summary
private final ObjectOutputStream out

socket	back to summary
private final Socket socket

Constructor Detail

Protocol	back to summary
public Protocol(Socket socket) throws IOException

Protocol	back to summary
public Protocol(Socket socket, InputStream inputStream) throws IOException Creates a protocol using a previously inspected input stream. The remote listener uses this overload after checking whether the connection is a plain-text health check rather than a serialized remote-operation request. Parameters socket:Socket the connection to communicate over; only its output stream is used inputStream:InputStream the stream to read requests from — a wrapper around the socket's input stream that supports non-destructive probing, restored to the start of the request

Protocol

back to summary

public Protocol(Socket socket, InputStream inputStream) throws IOException

Creates a protocol using a previously inspected input stream.

The remote listener uses this overload after checking whether the connection is a plain-text health check rather than a serialized remote-operation request.

Parameters

socket:Socket: the connection to communicate over; only its output stream is used
inputStream:InputStream: the stream to read requests from — a wrapper around the socket's input stream that supports non-destructive probing, restored to the start of the request

Method Detail

close back to summary

close	back to summary
public void close() Implements java.lang.AutoCloseable.close. Doc from java.lang.AutoCloseable.close. Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the `try`-with-resources statement. Annotations @Override

public void close()

Implements java.lang.AutoCloseable.close.

Doc from java.lang.AutoCloseable.close.

Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the try-with-resources statement.

Annotations

@Override

receiveMessage	back to summary
public Pair<RemoteMessage, Object> receiveMessage() throws IOException

sendMessage	back to summary
public void sendMessage(RemoteMessage type) throws IOException

sendMessage	back to summary
public void sendMessage(RemoteMessage type, Object argument) throws IOException

public Class Protocol

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail