Skip to content
This repository was archived by the owner on Aug 18, 2020. It is now read-only.

Commit 9c712ca

Browse files
committed
Add JavaDoc for RCON connector
1 parent 0986b8c commit 9c712ca

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
package org.codeoverflow.chatoverflow.api.io.input;
22

33
public interface RconInput extends Input {
4+
5+
/**
6+
* Get the output of a rcon command
7+
* Command will be directly executed on the rcon server and the returned response will be returned
8+
* If null is returned this means that there is some problem with the connection (typically the server is shut down or there is some other reason for a lost connection)
9+
* Notice: There is no way of knowing that a command exists, which does not return a response. Every command without response will return an empty string.
10+
* @param command the command which should be executed on the remote server
11+
* @return response of the server or null
12+
*/
413
String getCommandOutput(String command);
514
}

Diff for: src/main/java/org/codeoverflow/chatoverflow/api/io/output/RconOutput.java

+7
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,12 @@
22

33
public interface RconOutput extends Output {
44

5+
6+
/**
7+
* Execute a command on a remote (rcon) server.
8+
* Notice: There is no way of knowing if the commands exists.
9+
* @param command the command which should be executed
10+
* @return if the command was successfully sent to the server. (Returns false for e.g. a not anymore existent server)
11+
*/
512
boolean sendCommand(String command);
613
}

0 commit comments

Comments
 (0)