|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Server
Represents a low-level server connection.
Nested Class Summary | |
---|---|
static interface |
Server.ConnectionProgress
Interface used to report on progress of connection. |
static class |
Server.StatusPrefix
Mapping from mode letter to status prefix symbol |
Field Summary | |
---|---|
static int |
CHANMODE_ADDRESS
Channel mode is an 'address' mode that has a param whether + or - and can be sent from client without + or - to get a list of people affected. |
static int |
CHANMODE_ALWAYSPARAM
Channel mode always takes a parameter, whether + or -. |
static int |
CHANMODE_NOPARAM
Channel mode never takes a parameter. |
static int |
CHANMODE_SETPARAM
Channel mode takes a parameter when + but not when - (type C) |
static int |
CHANMODE_UNKNOWN
Unrecognised channel mode |
static int |
CHANMODE_USERSTATUS
Channel mode that applies to user status (from PREFIX). |
static java.lang.String |
IDENTIFYEVENT_CONNECT
Identify event constant: on connect |
static java.lang.String |
IDENTIFYEVENT_NICK
Identify event constant: on nick change |
static java.lang.String |
IDENTIFYEVENT_SERVICES
Identify event constant: when services come online |
static int |
UNTRACKED_REQUEST
Used to report that a server request is not tracked |
Method Summary | |
---|---|
void |
beginConnect(java.lang.String host,
int port,
Server.ConnectionProgress cp)
Starts the process of connecting to the server. |
void |
disconnect()
Disconnects from the server. |
void |
disconnectGracefully()
Disconnects from the server after sending a quit message. |
int |
getApproxPrefixLength()
|
int |
getChanModeParamCount()
|
java.lang.String |
getChanModes()
|
int |
getChanModeType(char mode)
|
java.lang.String |
getChanTypes()
|
java.lang.String |
getConnectedHost()
|
java.lang.String |
getConnectedIpAddress()
|
int |
getConnectedPort()
|
java.lang.String |
getCurrentShortName()
|
MessageDisplay |
getDefaultMessageDisplay()
|
java.lang.String |
getDefaultNick()
|
NetworkException |
getError()
|
java.lang.String |
getIdentifyCommand()
Deprecated. This is the old identify command, do not use |
java.lang.String |
getIdentifyPattern()
|
java.lang.String |
getISupport(java.lang.String parameter)
Access information from the RPL_ISUPPORT (005) numeric. |
java.net.InetAddress |
getLocalAddress()
|
int |
getMaxModeParams()
|
int |
getMaxTopicLength()
|
java.lang.String |
getNickPassword(java.lang.String nick)
|
java.lang.String |
getOurHost()
|
java.lang.String |
getOurNick()
|
java.lang.String |
getOurUser()
|
PreferencesGroup |
getPreferences()
|
Server.StatusPrefix[] |
getPrefix()
|
java.lang.Object |
getProperty(java.lang.Class<?> c,
java.lang.String key)
|
java.lang.String |
getQuitMessage()
|
java.lang.String |
getReportedHost()
|
java.lang.String |
getReportedOrConnectedHost()
|
java.lang.String |
getServerPassword()
|
java.lang.String |
getStatusMsg()
|
java.lang.String |
getVersion()
|
boolean |
isAway()
|
boolean |
isConnected()
|
boolean |
isConnectionFinished()
|
boolean |
isPrefixAtLeast(char prefix,
char required)
|
boolean |
isSecureConnection()
|
void |
sendLine(byte[] line)
Sends a line of data to the server. |
int |
sendServerRequest(byte[] line)
Sends a line of data to the server. |
java.lang.Object |
setProperty(java.lang.Class<?> c,
java.lang.String key,
java.lang.Object value)
|
boolean |
shouldIdentify(java.lang.String identifyEvent)
|
boolean |
silence(java.lang.String mask)
Attempt to silence the given mask. |
void |
suppressAutoJoin()
Prevents autojoin for the server. |
boolean |
unsilence(java.lang.String mask)
Attempt to unsilence the given mask. |
boolean |
wasQuitRequested()
|
Field Detail |
---|
static final int UNTRACKED_REQUEST
static final java.lang.String IDENTIFYEVENT_CONNECT
static final java.lang.String IDENTIFYEVENT_NICK
static final java.lang.String IDENTIFYEVENT_SERVICES
static final int CHANMODE_UNKNOWN
static final int CHANMODE_ADDRESS
static final int CHANMODE_ALWAYSPARAM
static final int CHANMODE_SETPARAM
static final int CHANMODE_NOPARAM
static final int CHANMODE_USERSTATUS
Method Detail |
---|
void beginConnect(java.lang.String host, int port, Server.ConnectionProgress cp)
host
- Host for connectionport
- Port for connectioncp
- Object that monitors progress of connectionboolean isConnected()
boolean isConnectionFinished()
boolean isSecureConnection()
NetworkException getError()
boolean wasQuitRequested()
MessageDisplay getDefaultMessageDisplay() throws java.lang.IllegalStateException
java.lang.IllegalStateException
- If
Connections.setDefaultMessageDisplay was not calledvoid sendLine(byte[] line)
line
- Line of data, not including CRLFsendServerRequest(byte[])
int sendServerRequest(byte[] line)
line
- Line of data, not including CRLF
ServerIRCMsg.getResponseID()
void disconnectGracefully()
void disconnect()
java.lang.String getOurNick()
java.lang.String getOurUser()
java.lang.String getOurHost()
int getApproxPrefixLength()
java.lang.String getReportedHost()
java.lang.String getConnectedHost()
int getConnectedPort()
java.lang.String getConnectedIpAddress()
java.net.InetAddress getLocalAddress()
java.lang.String getCurrentShortName()
java.lang.String getReportedOrConnectedHost()
java.lang.String getVersion()
PreferencesGroup getPreferences()
BugException
- If not connected (or something else goes horribly wrong)java.lang.String getDefaultNick()
java.lang.String getQuitMessage()
java.lang.String getServerPassword()
java.lang.String getNickPassword(java.lang.String nick)
nick
- Nickname
boolean shouldIdentify(java.lang.String identifyEvent)
identifyEvent
- An IDENTIFYEVENT_xx constant
java.lang.String getIdentifyCommand()
java.lang.String getIdentifyPattern()
java.lang.String getISupport(java.lang.String parameter)
parameter
- ISUPPORT parameter name
java.lang.String getChanTypes()
java.lang.String getStatusMsg()
int getMaxModeParams()
int getMaxTopicLength()
Server.StatusPrefix[] getPrefix()
boolean isPrefixAtLeast(char prefix, char required)
prefix
- User's prefixrequired
- Required prefix
java.lang.String getChanModes()
int getChanModeType(char mode)
mode
- Mode letter
int getChanModeParamCount()
java.lang.Object getProperty(java.lang.Class<?> c, java.lang.String key)
c
- Class that owns propertykey
- Property key
java.lang.Object setProperty(java.lang.Class<?> c, java.lang.String key, java.lang.Object value)
c
- Class that owns propertykey
- Property keyvalue
- New value for property
boolean silence(java.lang.String mask)
mask
- Mask to silence
boolean unsilence(java.lang.String mask)
mask
- Mask to silence
boolean isAway()
void suppressAutoJoin()
ServerConnectionFinishedMsg
is sent, e.g. while handling
ServerConnectedMsg
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |