|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Method Summary | |
---|---|
OEMessage[] |
delete(OEMessage in0)
Delete the given block of text at the current cursor position. |
OEMessage[] |
download(OEMessage in0)
Sends the current state of the buffer to the requesting client. |
OEMessage[] |
guard(OEMessage in0)
Guard a block of text to prevent others from editting or modifying it. |
OEMessage[] |
insert(OEMessage in0)
Inserts a block of text at the current cursor position. |
java.lang.String[] |
listChannels()
Returns the channelIDs associated with channels hosted by the server. |
OEMessage[] |
mark(OEMessage in0)
Creates a mark at the current cursor position. |
OEMessage[] |
move(OEMessage in0)
Moves the client cursor to the specified position. |
OEMessage[] |
removeGuard(OEMessage in0)
Removes the guard currently placed on the channel. |
OEMessage[] |
removeMark(OEMessage in0)
Removes a client's mark. |
OEMessage[] |
select(OEMessage in0)
Selects a block of text from the closest mark to the current cursor position. |
OEMessage[] |
upload(OEMessage[] in0)
Merges all the commands encapsulated by an array of OEMessage objects into the server buffer. |
Method Detail |
public OEMessage[] upload(OEMessage[] in0) throws java.rmi.RemoteException, InvalidChannelException, InvalidClientException, ConflictException, BufferOutOfRangeException, NameInUseException, ClientNameInUseException
OEMessage
objects into the server buffer. OEMessage
objects represents all the changes (ie insertions, deletions, cursor-move) which the client requires to merge with the server buffer.
If the specified clientIDs or channelIDs do not exist then they are automatically created.
in0
- An array of valid OEMessage
objects. A valid OEMessage
object is one that encapsulates one or more of the following commands: OEMessage
objects denoting the changes made to the server since the client's last connection. This includes the changes which the client "sent-up" to the server
java.rmi.RemoteException
InvalidChannelException
- If the Client name is null
ConflictException
- If the requested change conflicts with the current Server state.
InvalidClientException
- If the Client name is null
BufferOutOfRangeException
- If a requested command operates outside of the server buffer range (e.g. Inserting a string at position 10 if the max buffer position is 2).
NameInUseException
- When attempting to create a previously existingxisting channel or mark.
ClientNameInUseException
- When attempting to create a previously existingxisting client.public OEMessage[] download(OEMessage in0) throws java.rmi.RemoteException, InvalidChannelException, InvalidClientException, ClientNameInUseException
in0
- A OEMessage
object which specifies clientID and channelID fields.
OEMessage
objects denoting the changes made to the server since the client's last connection. If it is the first dowload (ie one the required the creation of either of channelID or clientID), it will send back the contents of the full buffer as two commands: MOVE command to move cursor to position 0, and an INSERT command specifing the full buffer.
java.rmi.RemoteException
InvalidChannelException
- If the Client name is null
ConflictException
- If the requested change conflicts with the current Server state (Should not be thrown).
InvalidClientException
- If the Client name is null
BufferOutOfRangeException
- If a requested command operates outside of the server buffer range (e.g. Inserting a string at position 10 if the max buffer position is 2).
NameInUseException
- When attempting to create a previously existingxisting channel or mark.
ClientNameInUseException
- When attempting to create a previously existingxisting client.public OEMessage[] move(OEMessage in0) throws java.rmi.RemoteException, InvalidChannelException, BufferOutOfRangeException, InvalidClientException, ClientNameInUseException
in0
- A OEMessage
object which specifies clientID and channelID fields as well as OECommandMove
command specifing position for cursor to move to.
OEMessage
objects denoting the changes made to the server since the client's last connection.
java.rmi.RemoteException
InvalidChannelException
- If the Client name is null
, or if channel is non-existent
InvalidClientException
- If the Client name is null
, expired (after 10 mins), or non-existent.
BufferOutOfRangeException
- If a requested command operates outside of the server buffer range (e.g. Inserting a string at position 10 if the max buffer position is 2).
ClientNameInUseException
- When attempting to create a previously existingxisting client (should not be thrown).public OEMessage[] mark(OEMessage in0) throws java.rmi.RemoteException, InvalidChannelException, BufferOutOfRangeException, InvalidClientException, NameInUseException, ClientNameInUseException
in0
- A OEMessage
object which specifies clientID and channelID fields as well as OECommandMark
command specifing mark name.
OEMessage
objects denoting the changes made to the server since the client's last connection.
java.rmi.RemoteException
InvalidChannelException
- If the Client name is null
, or if channel is non-existent
InvalidClientException
- If the Client name is null
, expired (after 10 mins), or non-existent.
BufferOutOfRangeException
- If a requested command operates outside of the server buffer range (e.g. Inserting a string at position 10 if the max buffer position is 2).
ClientNameInUseException
- When attempting to create a previously existingxisting client (should not be thrown).
NameInUseException
- If the mark already exists.public OEMessage[] removeMark(OEMessage in0) throws java.rmi.RemoteException, InvalidChannelException, InvalidClientException, ClientNameInUseException
in0
- A OEMessage
object which specifies clientID and channelID fields as well as OECommandRemoveMark
command specifing clientID.
OEMessage
objects denoting the changes made to the server since the client's last connection.
java.rmi.RemoteException
InvalidChannelException
- If the Client name is null
, or if channel is non-existent
InvalidClientException
- If the Client name is null
, expired (after 10 mins), or non-existent.
ClientNameInUseException
- When attempting to create a previously existingxisting client (should not be thrown).public OEMessage[] select(OEMessage in0) throws java.rmi.RemoteException, InvalidChannelException, InvalidClientException, ClientNameInUseException
in0
- AOEMessage
object which specifies clientID and channelID fields as well as OECommandSelect
command specifing clientID.
OEMessage
objects denoting the changes made to the server since the client's last connection.
java.rmi.RemoteException
InvalidChannelException
- If the Client name is null
, or if channel is non-existent
InvalidClientException
- If the Client name is null
, expired (after 10 mins), or non-existent.
ClientNameInUseException
- When attempting to create a previously existingxisting client (should not be thrown).public OEMessage[] insert(OEMessage in0) throws java.rmi.RemoteException, InvalidChannelException, InvalidClientException, ConflictException, ClientNameInUseException
in0
- A OEMessage
object which specifies clientID and channelID fields as well as OECommandInsert
command specifing block of text to be inserted.
OEMessage
objects denoting the changes made to the server since the client's last connection.
java.rmi.RemoteException
InvalidChannelException
- If the Client name is null
, or if channel is non-existent
InvalidClientException
- If the Client name is null
, expired (after 10 mins), or non-existent.
ClientNameInUseException
- When attempting to create a previously existingxisting client (should not be thrown).
ConflictException
- If the requested change conflicts with the current Server state.public OEMessage[] delete(OEMessage in0) throws java.rmi.RemoteException, InvalidChannelException, InvalidClientException, ConflictException, ClientNameInUseException
in0
- A OEMessage
object which specifies clientID and channelID fields as well as OECommandDelete
command specifing block of text to be deleted.
OEMessage
objects denoting the changes made to the server since the client's last connection.
java.rmi.RemoteException
InvalidChannelException
- If the Client name is null
, or if channel is non-existent
InvalidClientException
- If the Client name is null
, expired (after 10 mins), or non-existent.
ClientNameInUseException
- When attempting to create a previously existingxisting client (should not be thrown).
ConflictException
- If the requested change conflicts with the current Server state.public OEMessage[] guard(OEMessage in0) throws java.rmi.RemoteException, InvalidChannelException, InvalidClientException, ConflictException, ClientNameInUseException
in0
- A OEMessage
object which specifies clientID and channelID fields as well as OECommandGuard
command specifing beginning and ending offset to be guarded.
OEMessage
objects denoting the changes made to the server since the client's last connection.
java.rmi.RemoteException
InvalidChannelException
- If the Client name is null
, or if channel is non-existent
InvalidClientException
- If the Client name is null
, expired (after 10 mins), or non-existent.
ClientNameInUseException
- When attempting to create a previously existingxisting client (should not be thrown).
ConflictException
- If the requested change conflicts with the current Server state.public OEMessage[] removeGuard(OEMessage in0) throws java.rmi.RemoteException, InvalidChannelException, InvalidClientException, ClientNameInUseException
in0
- A OEMessage
object which specifies clientID and channelID fields as well as OECommandRemoveGuard
command specifing the clientID.
OEMessage
objects denoting the changes made to the server since the client's last connection.
java.rmi.RemoteException
InvalidChannelException
- If the Client name is null
, or if channel is non-existent
InvalidClientException
- If the Client name is null
, expired (after 10 mins), or non-existent.
ClientNameInUseException
- When attempting to create a previously existingxisting client (should not be thrown).
ConflictException
- If the requested change conflicts with the current Server state.public java.lang.String[] listChannels()
String
containing channelIDs of
channels hosted by the server.
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |