blob: 244630fd8ca78cb23566223e41f5c1261f7075f5 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
/*******************************************************************************
* Copyright (c) 2013 Wind River Systems, Inc. and others. All rights reserved.
* This program and the accompanying materials are made available under the terms
* of the Eclipse Public License v1.0 which accompanies this distribution, and is
* available at http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Wind River Systems - initial API and implementation
*******************************************************************************/
package org.eclipse.tcf.te.core.interfaces;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.tcf.te.runtime.interfaces.callback.ICallback;
/**
* IConnectable
*/
public interface IConnectable {
// intermediate states are always < 0
public static final int STATE_CONNECTING = -12;
public static final int STATE_CONNECT_SCHEDULED = -11;
public static final int STATE_DISCONNECTING = -2;
public static final int STATE_DISCONNECT_SCHEDULED = -1;
// main states
public static final int STATE_UNKNOWN = 0;
public static final int STATE_DISCONNECTED = 1;
public static final int STATE_CONNECTED = 11;
// state change actions
public static final int ACTION_UNKNOWN = STATE_UNKNOWN;
public static final int ACTION_DISCONNECT = STATE_DISCONNECTED;
public static final int ACTION_CONNECT = STATE_CONNECTED;
/**
* Get the current connect state.
*
* @return The current connect state.
*/
public int getConnectState();
/**
* Set the connect state property of the IConnectable.
* @param state The state.
* @return <code>true</code> if the state was set.
*/
public boolean setConnectState(int state);
/**
* Change the current connect state to the new state if possible.
* Only states >= 0 are allowed.
*
* @param state The new state.
* @param callback The callback to indicate that the state change has been finished.
* @param monitor The progress monitor. If <code>null</code> a new job will be scheduled.
*
* @throws IllegalArgumentException if the given state is not allowed (only states >= 0 are allowed)
*/
public void changeConnectState(int state, ICallback callback, IProgressMonitor monitor) throws IllegalArgumentException;
/**
* Check whether a state change to the given state is allowed.
*
* @param state The new state to check.
* @return <code>true</code> if a state change to the given state is currently allwoed.
*/
public boolean isConnectStateChangeAllowed(int state);
/**
* Check whether a state change action is allowed.
*
* @param action The action to execute.
* @return <code>true</code> if a state change action is currently allwoed.
*/
public boolean isConnectStateChangeActionAllowed(int action);
}
|
