kirillius
/
mikrotik-java
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added command timeouts as requested in #16

This commit is contained in:
Gideon le Grange 2015-03-29 22:40:01 +02:00
parent c297aba43e
commit 6a73b28b59
2 changed files with 18 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/main/java/examples/Config.java
View File

@ -8,8 +8,8 @@ public class Config {
public static final String HOST = "192.168.1.34"; public static final String HOST = "192.168.1.34";
public static final String USERNAME = "gideon"; public static final String USERNAME = "admin";
public static final String PASSWORD = "minapp"; public static final String PASSWORD = "";
} }

22
src/main/java/me/legrange/mikrotik/ApiConnection.java
View File

@ -25,12 +25,12 @@ public abstract class ApiConnection {
* Create a new API connection to the give device on the supplied port, using anonymous TLS for encryption. * Create a new API connection to the give device on the supplied port, using anonymous TLS for encryption.
* @param host The host to which to connect. * @param host The host to which to connect.
* @param port The TCP port to use. * @param port The TCP port to use.
* @param timeOut The connection timeout to use when opening the connection. * @param timeout The connection timeout to use when opening the connection.
* @return The ApiConnection * @return The ApiConnection
* @throws me.legrange.mikrotik.MikrotikApiException Thrown if there is a problem connecting * @throws me.legrange.mikrotik.MikrotikApiException Thrown if there is a problem connecting
*/ */
public static ApiConnection connectTLS(String host, int port, int timeOut) throws MikrotikApiException { public static ApiConnection connectTLS(String host, int port, int timeout) throws MikrotikApiException {
return ApiConnectionImpl.connect(host, port, true, timeOut); return ApiConnectionImpl.connect(host, port, true, timeout);
} }
@ -60,12 +60,12 @@ public abstract class ApiConnection {
* Create a new API connection to the give device on the supplied port * Create a new API connection to the give device on the supplied port
* @param host The host to which to connect. * @param host The host to which to connect.
* @param port The TCP port to use. * @param port The TCP port to use.
* @param timeOut The connection timeout to use when opening the connection. * @param timeout The connection timeout to use when opening the connection.
* @return The ApiConnection * @return The ApiConnection
* @throws me.legrange.mikrotik.MikrotikApiException Thrown if there is a problem connecting * @throws me.legrange.mikrotik.MikrotikApiException Thrown if there is a problem connecting
*/ */
public static ApiConnection connect(String host, int port, int timeOut) throws MikrotikApiException { public static ApiConnection connect(String host, int port, int timeout) throws MikrotikApiException {
return ApiConnectionImpl.connect(host, port, false, timeOut); return ApiConnectionImpl.connect(host, port, false, timeout);
} }
/** /**
@ -135,12 +135,22 @@ public abstract class ApiConnection {
/** get the command timeout. The command timeout is used to time out API /** get the command timeout. The command timeout is used to time out API
* commands after a specific time. * commands after a specific time.
*
* Note: This is not the same as the timeout value passed in the connect() and
* connectTLS() methods. This timeout is specific to synchronous commands, that
* timeout is applied to opening the API socket.
*
* @return The time out in milliseconds. * @return The time out in milliseconds.
*/ */
public abstract int getTimeout(); public abstract int getTimeout();
/** set the command timeout. The command timeout is used to time out API /** set the command timeout. The command timeout is used to time out API
* commands after a specific time. * commands after a specific time.
*
* Note: This is not the same as the timeout value passed in the connect() and
* connectTLS() methods. This timeout is specific to synchronous commands, that
* timeout is applied to opening the API socket.
*
* @param timeout The time out in milliseconds. * @param timeout The time out in milliseconds.
* @throws MikrotikApiException Thrown if the timeout specified is invalid. * @throws MikrotikApiException Thrown if the timeout specified is invalid.
*/ */