jGCS Documentation
A B C D E G H I J L M N O P R S T U

A

AbstractBlockSession - Class in net.sf.jgcs.membership
 
AbstractBlockSession() - Constructor for class net.sf.jgcs.membership.AbstractBlockSession
 
AbstractControlSession - Class in net.sf.jgcs
This class defines a AbstractControlSession.
AbstractControlSession() - Constructor for class net.sf.jgcs.AbstractControlSession
 
AbstractDataSession - Class in net.sf.jgcs
This class defines a AbstractDataSession.
AbstractDataSession(AbstractProtocol, GroupConfiguration) - Constructor for class net.sf.jgcs.AbstractDataSession
 
AbstractMarshallableSocketAddress - Class in net.sf.jgcs.utils
 
AbstractMarshallableSocketAddress() - Constructor for class net.sf.jgcs.utils.AbstractMarshallableSocketAddress
 
AbstractMembershipSession - Class in net.sf.jgcs.membership
 
AbstractMembershipSession() - Constructor for class net.sf.jgcs.membership.AbstractMembershipSession
 
AbstractMultiThreadedPollingProtocol - Class in net.sf.jgcs
This class defines a AbstractMultiThreadedPollingProtocol.
AbstractMultiThreadedPollingProtocol() - Constructor for class net.sf.jgcs.AbstractMultiThreadedPollingProtocol
 
AbstractMultiThreadedPollingProtocol.ProtocolReader<C> - Class in net.sf.jgcs
 
AbstractMultiThreadedPollingProtocol.ProtocolReader() - Constructor for class net.sf.jgcs.AbstractMultiThreadedPollingProtocol.ProtocolReader
 
AbstractPollingDataSession - Class in net.sf.jgcs
Data session that directly polls I/O.
AbstractPollingDataSession(AbstractProtocol, GroupConfiguration) - Constructor for class net.sf.jgcs.AbstractPollingDataSession
 
AbstractPollingProtocol - Class in net.sf.jgcs
This class defines a AbstractPollingProtocol.
AbstractPollingProtocol() - Constructor for class net.sf.jgcs.AbstractPollingProtocol
 
AbstractProtocol - Class in net.sf.jgcs
This class defines a AbstractProtocol It partially implements a protocol with the mappings between a configuration and a pair of control and data sessions.
AbstractProtocol() - Constructor for class net.sf.jgcs.AbstractProtocol
 
add(T) - Method in class net.sf.jgcs.utils.Mailbox
 
addMessageListener(MessageListener) - Method in class net.sf.jgcs.adapters.MultipleMessageListeners
Adds a message listener.
Annotation - Interface in net.sf.jgcs
This class defines a Annotation.

B

BlockingReceiver - Class in net.sf.jgcs.adapters
This adapter implements a receive() method on top of the given DataSession.
BlockingReceiver(DataSession) - Constructor for class net.sf.jgcs.adapters.BlockingReceiver
This constructor registers it self as a listener for message and exception listeners.
BlockListener - Interface in net.sf.jgcs.membership
This class defines a BlockListener.
blockOk() - Method in interface net.sf.jgcs.membership.BlockSession
This method must be used by the application after it received a block notification and flushed all pending messages.
BlockSession - Interface in net.sf.jgcs.membership
This class defines a BlockSession.
boot() - Method in class net.sf.jgcs.AbstractControlSession
Initializes any variables needed by this session.
boot() - Method in class net.sf.jgcs.AbstractDataSession
 
boot() - Method in class net.sf.jgcs.AbstractMultiThreadedPollingProtocol
 
boot() - Method in class net.sf.jgcs.AbstractPollingDataSession
 
boot() - Method in class net.sf.jgcs.AbstractPollingProtocol
 
boot() - Method in class net.sf.jgcs.AbstractProtocol
 
boot() - Method in class net.sf.jgcs.membership.AbstractBlockSession
 
boot() - Method in class net.sf.jgcs.membership.AbstractMembershipSession
 

C

cleanup() - Method in class net.sf.jgcs.AbstractPollingDataSession
 
close() - Method in class net.sf.jgcs.AbstractDataSession
 
close() - Method in class net.sf.jgcs.AbstractPollingDataSession
 
close() - Method in interface net.sf.jgcs.DataSession
Closes the session.
ClosedSessionException - Exception in net.sf.jgcs
This class defines a ClosedSessionException.
ClosedSessionException() - Constructor for exception net.sf.jgcs.ClosedSessionException
 
ClosedSessionException(String, Throwable) - Constructor for exception net.sf.jgcs.ClosedSessionException
 
ClosedSessionException(String) - Constructor for exception net.sf.jgcs.ClosedSessionException
 
compare(Service) - Method in interface net.sf.jgcs.Service
Compares two Services of the same protocol.
ControlListener - Interface in net.sf.jgcs
This class defines a ControlListener.
ControlSession - Interface in net.sf.jgcs
This class defines a ControlSession.
controlSessions - Variable in class net.sf.jgcs.AbstractProtocol
 
createMessage() - Method in interface net.sf.jgcs.DataSession
Creates an empty message that can be used (transmitted) through the session.
createProtocol() - Method in interface net.sf.jgcs.ProtocolFactory
Creates a new Protocol that represents a toolkit.

D

DataSession - Interface in net.sf.jgcs
This class defines a DataSession.
DataSessionException - Exception in net.sf.jgcs
This class defines a DataSessionException.
DataSessionException() - Constructor for exception net.sf.jgcs.DataSessionException
Creates a new DataSessionException.
DataSessionException(String) - Constructor for exception net.sf.jgcs.DataSessionException
Creates a new DataSessionException.
DataSessionException(String, Throwable) - Constructor for exception net.sf.jgcs.DataSessionException
Creates a new DataSessionException.
dataSessions - Variable in class net.sf.jgcs.AbstractProtocol
 

E

ExceptionListener - Interface in net.sf.jgcs
This class defines a ExceptionListener.

G

getBytes(SocketAddress) - Method in class net.sf.jgcs.utils.AbstractMarshallableSocketAddress
 
getBytes(MembershipID) - Method in interface net.sf.jgcs.utils.Marshallable
 
getBytes(SocketAddress) - Method in interface net.sf.jgcs.utils.Marshallable
 
getCause() - Method in exception net.sf.jgcs.JGCSException
Gets the throwable that caused this exception.
getChannel() - Method in class net.sf.jgcs.AbstractMultiThreadedPollingProtocol.ProtocolReader
 
getCoordinatorRank() - Method in interface net.sf.jgcs.membership.Membership
Gets the rank of the coordinator of this group.
getErrorCode() - Method in exception net.sf.jgcs.JGCSException
Gets the error code that identifies the error ocurred.
getFailedMembers() - Method in interface net.sf.jgcs.membership.Membership
Gets a list of members that failed since the previous membership.
getGroup() - Method in class net.sf.jgcs.AbstractDataSession
 
getGroup() - Method in class net.sf.jgcs.AbstractMultiThreadedPollingProtocol.ProtocolReader
 
getGroup() - Method in interface net.sf.jgcs.DataSession
Gets the group associated with this session.
getJoinedMembers() - Method in interface net.sf.jgcs.membership.Membership
Gets a list of members that joined the group since the previous membership.
getLeavedMembers() - Method in interface net.sf.jgcs.membership.Membership
Gets a list of members that leaved the group since the previous membership.
getLocalAddress() - Method in interface net.sf.jgcs.ControlSession
Gets the local address.
getLocalRank() - Method in interface net.sf.jgcs.membership.Membership
Gets the local rank of the member in this membership.
getMemberAddress(int) - Method in interface net.sf.jgcs.membership.Membership
Gets the socket address of the member that has the given rank.
getMemberRank(SocketAddress) - Method in interface net.sf.jgcs.membership.Membership
Gets the member rank that has the given socket address, or null if there is no matching rank.
getMembership() - Method in class net.sf.jgcs.membership.AbstractMembershipSession
 
getMembership() - Method in interface net.sf.jgcs.membership.MembershipSession
Gets the current Membership.
getMembershipID() - Method in class net.sf.jgcs.membership.AbstractMembershipSession
 
getMembershipID() - Method in interface net.sf.jgcs.membership.Membership
Gets the current membership ID.
getMembershipID() - Method in interface net.sf.jgcs.membership.MembershipSession
Gets the current membership ID
getMembershipID(byte[]) - Method in interface net.sf.jgcs.utils.Marshallable
 
getMembershipList() - Method in interface net.sf.jgcs.membership.Membership
Gets the current view of the membership.
getPayload() - Method in interface net.sf.jgcs.Message
Gets the payload from the message.
getSenderAddress() - Method in interface net.sf.jgcs.Message
Gets the sender address.
getSocketAddress(byte[]) - Method in class net.sf.jgcs.utils.AbstractMarshallableSocketAddress
 
getSocketAddress(byte[]) - Method in interface net.sf.jgcs.utils.Marshallable
 
GroupConfiguration - Interface in net.sf.jgcs
This class defines a GroupConfiguration.

H

hasAllListeners() - Method in class net.sf.jgcs.AbstractControlSession
Returns true if all listeners are registered.
hasAllListeners() - Method in class net.sf.jgcs.membership.AbstractBlockSession
 
hasAllListeners() - Method in class net.sf.jgcs.membership.AbstractMembershipSession
 

I

isBlocked() - Method in interface net.sf.jgcs.membership.BlockSession
Verifies if the group is blocked or not.
isJoined() - Method in interface net.sf.jgcs.ControlSession
Verifies if the member belongs to a group.

J

JGCSException - Exception in net.sf.jgcs
This class defines a JGCSException.
JGCSException() - Constructor for exception net.sf.jgcs.JGCSException
Creates a new JGCSException.
JGCSException(String) - Constructor for exception net.sf.jgcs.JGCSException
Creates a new JGCSException.
JGCSException(String, Throwable) - Constructor for exception net.sf.jgcs.JGCSException
Creates a new JGCSException.
JGCSException(String, int) - Constructor for exception net.sf.jgcs.JGCSException
Creates a new JGCSException.
JGCSException(String, Throwable, int) - Constructor for exception net.sf.jgcs.JGCSException
Creates a new JGCSException.
join() - Method in interface net.sf.jgcs.ControlSession
Joins the group.

L

leave() - Method in interface net.sf.jgcs.ControlSession
Leaves the group.
lookupControlSession(GroupConfiguration) - Method in class net.sf.jgcs.AbstractProtocol
 
lookupDataSession(GroupConfiguration) - Method in class net.sf.jgcs.AbstractProtocol
 

M

Mailbox<T> - Class in net.sf.jgcs.utils
 
Mailbox() - Constructor for class net.sf.jgcs.utils.Mailbox
 
Marshallable - Interface in net.sf.jgcs.utils
 
Membership - Interface in net.sf.jgcs.membership
This class defines a Membership.
MembershipID - Interface in net.sf.jgcs.membership
This class defines a MembershipID.
MembershipListener - Interface in net.sf.jgcs.membership
This class defines a MembershipListener.
MembershipSession - Interface in net.sf.jgcs.membership
This class defines a MembershipSession.
Message - Interface in net.sf.jgcs
This class defines a Message.
MessageListener - Interface in net.sf.jgcs
This class defines a MessageListener.
multicast(Message, Service, Object, Annotation...) - Method in interface net.sf.jgcs.DataSession
Sends a message to the group.
MultipleMessageListeners - Class in net.sf.jgcs.adapters
This adapter is used to register several listeners on the same DataSession.
MultipleMessageListeners(DataSession, boolean) - Constructor for class net.sf.jgcs.adapters.MultipleMessageListeners
Creates a new Adapter instance.

N

net.sf.jgcs - package net.sf.jgcs
This package defines the basic interface for group membership.
net.sf.jgcs.adapters - package net.sf.jgcs.adapters
jGCS adapters.
net.sf.jgcs.membership - package net.sf.jgcs.membership
This package provides extentions for membership and flush.
net.sf.jgcs.utils - package net.sf.jgcs.utils
 
notifyAndSetMembership(Membership) - Method in class net.sf.jgcs.membership.AbstractMembershipSession
 
notifyBlock() - Method in class net.sf.jgcs.membership.AbstractBlockSession
 
notifyExceptionListeners(JGCSException) - Method in class net.sf.jgcs.AbstractControlSession
Notifies the exception listener.
notifyExceptionListeners(JGCSException) - Method in class net.sf.jgcs.AbstractDataSession
 
notifyFailed(SocketAddress) - Method in class net.sf.jgcs.AbstractControlSession
Notifies the control listener that a member has failed.
notifyJoin(SocketAddress) - Method in class net.sf.jgcs.AbstractControlSession
Notifies the control listener of a new member in the group.
notifyLeave(SocketAddress) - Method in class net.sf.jgcs.AbstractControlSession
Notifies the control listener of a leaved member.
notifyMessageListeners(Message) - Method in class net.sf.jgcs.AbstractDataSession
 
notifyRemoved() - Method in class net.sf.jgcs.membership.AbstractMembershipSession
 
notifyServiceListeners(Object, Service) - Method in class net.sf.jgcs.AbstractDataSession
 
NotJoinedException - Exception in net.sf.jgcs
This class defines a NotJoinedException.
NotJoinedException() - Constructor for exception net.sf.jgcs.NotJoinedException
Creates a new NotJoinedException.
NotJoinedException(String) - Constructor for exception net.sf.jgcs.NotJoinedException
Creates a new NotJoinedException.
NotJoinedException(String, Throwable) - Constructor for exception net.sf.jgcs.NotJoinedException
Creates a new NotJoinedException.
NotJoinedException(String, int) - Constructor for exception net.sf.jgcs.NotJoinedException
Creates a new NotJoinedException.
NotJoinedException(String, Throwable, int) - Constructor for exception net.sf.jgcs.NotJoinedException
Creates a new NotJoinedException.

O

onBlock() - Method in interface net.sf.jgcs.membership.BlockListener
Block notification.
onException(JGCSException) - Method in interface net.sf.jgcs.ExceptionListener
Notification of an exception that occurred when the underlying implementation was receiving a message.
onExcluded() - Method in interface net.sf.jgcs.membership.MembershipListener
Notification from the membership to indicate that the registered member does not belong to the group any more.
onFailed(SocketAddress) - Method in interface net.sf.jgcs.ControlListener
Notification of a member that was detected as failed.
onJoin(SocketAddress) - Method in interface net.sf.jgcs.ControlListener
Notification of a new member in the group.
onLeave(SocketAddress) - Method in interface net.sf.jgcs.ControlListener
Notification of a member that leaved the group.
onMembershipChange() - Method in interface net.sf.jgcs.membership.MembershipListener
Notification of a MembershipChange.
onMessage(Message) - Method in interface net.sf.jgcs.MessageListener
Delivers a message from the channel to the application.
onServiceEnsured(Object, Service) - Method in interface net.sf.jgcs.ServiceListener
Notifies the application that one certain service to a message delivery is already ensured.
openControlSession(GroupConfiguration) - Method in interface net.sf.jgcs.Protocol
Creates a new Control Session.
openDataSession(GroupConfiguration) - Method in interface net.sf.jgcs.Protocol
Creates e new Data Session.

P

pool - Variable in class net.sf.jgcs.AbstractPollingDataSession
 
Protocol - Interface in net.sf.jgcs
This interface defines a Protocol represents an instance of the toolkit used to implement the Group Communication Service (GCS).
ProtocolFactory - Interface in net.sf.jgcs
This class defines a ProtocolFactory This factory must be used to create instances of Protocols.
putSessions(GroupConfiguration, AbstractControlSession, AbstractDataSession) - Method in class net.sf.jgcs.AbstractProtocol
 

R

read() - Method in class net.sf.jgcs.AbstractMultiThreadedPollingProtocol.ProtocolReader
 
read() - Method in class net.sf.jgcs.AbstractPollingDataSession
 
read() - Method in class net.sf.jgcs.AbstractPollingProtocol
 
receive(Object) - Method in class net.sf.jgcs.adapters.BlockingReceiver
Receives a message for the group.
receive() - Method in class net.sf.jgcs.adapters.BlockingReceiver
Receives a message for the group.
receive(long, Object) - Method in class net.sf.jgcs.adapters.BlockingReceiver
Receives a message for the group.
removeMessageListener(MessageListener) - Method in class net.sf.jgcs.adapters.MultipleMessageListeners
Removes a message listener.
removeNext() - Method in class net.sf.jgcs.utils.Mailbox
 
removeNext(long) - Method in class net.sf.jgcs.utils.Mailbox
 
removeSessions(GroupConfiguration) - Method in class net.sf.jgcs.AbstractProtocol
 
run() - Method in class net.sf.jgcs.AbstractMultiThreadedPollingProtocol.ProtocolReader
 

S

send(Message, Service, Object, SocketAddress, Annotation...) - Method in interface net.sf.jgcs.DataSession
Sends a message to one particular member of the group.
Service - Interface in net.sf.jgcs
This class defines a Service.
ServiceListener - Interface in net.sf.jgcs
This class defines a ServiceListener.
setBlockListener(BlockListener) - Method in class net.sf.jgcs.membership.AbstractBlockSession
 
setBlockListener(BlockListener) - Method in interface net.sf.jgcs.membership.BlockSession
Registers a listener for the block notification.
setChannel(C) - Method in class net.sf.jgcs.AbstractMultiThreadedPollingProtocol.ProtocolReader
 
setControlListener(ControlListener) - Method in class net.sf.jgcs.AbstractControlSession
Sets the control listener.
setControlListener(ControlListener) - Method in interface net.sf.jgcs.ControlSession
Adds a listener to deliver group membership notifications.
setExceptionListener(ExceptionListener) - Method in class net.sf.jgcs.AbstractControlSession
Sets the exception listener.
setExceptionListener(ExceptionListener) - Method in class net.sf.jgcs.AbstractDataSession
 
setExceptionListener(ExceptionListener) - Method in interface net.sf.jgcs.ControlSession
Adds a listener to deliver exceptions related to message reception and membership notifications.
setExceptionListener(ExceptionListener) - Method in interface net.sf.jgcs.DataSession
Adds a listener to deliver exceptions related to message reception.
setFields(GroupConfiguration, C) - Method in class net.sf.jgcs.AbstractMultiThreadedPollingProtocol.ProtocolReader
 
setGroup(GroupConfiguration) - Method in class net.sf.jgcs.AbstractMultiThreadedPollingProtocol.ProtocolReader
 
setJoined(boolean) - Method in class net.sf.jgcs.membership.AbstractBlockSession
 
setMembership(Membership) - Method in class net.sf.jgcs.membership.AbstractMembershipSession
 
setMembershipListener(MembershipListener) - Method in class net.sf.jgcs.membership.AbstractMembershipSession
 
setMembershipListener(MembershipListener) - Method in interface net.sf.jgcs.membership.MembershipSession
Registers a listener for the membership changes.
setMessageListener(MessageListener) - Method in class net.sf.jgcs.AbstractDataSession
 
setMessageListener(MessageListener) - Method in interface net.sf.jgcs.DataSession
Adds a listener to deliver messages from this channel.
setPayload(byte[]) - Method in interface net.sf.jgcs.Message
Sets the payload for the message.
setSenderAddress(SocketAddress) - Method in interface net.sf.jgcs.Message
Sets the sender address.
setServiceListener(ServiceListener) - Method in class net.sf.jgcs.AbstractDataSession
 
setServiceListener(ServiceListener) - Method in interface net.sf.jgcs.DataSession
Adds a listener to deliver notifications from this channel.
startReader(AbstractMultiThreadedPollingProtocol.ProtocolReader) - Method in class net.sf.jgcs.AbstractMultiThreadedPollingProtocol
 

T

task - Variable in class net.sf.jgcs.AbstractPollingDataSession
 

U

UnsupportedServiceException - Exception in net.sf.jgcs
This class defines a UnsupportedServiceException.
UnsupportedServiceException() - Constructor for exception net.sf.jgcs.UnsupportedServiceException
Creates a new UnsupportedServiceException.
UnsupportedServiceException(String) - Constructor for exception net.sf.jgcs.UnsupportedServiceException
Creates a new UnsupportedServiceException.
UnsupportedServiceException(String, Throwable) - Constructor for exception net.sf.jgcs.UnsupportedServiceException
Creates a new UnsupportedServiceException.

A B C D E G H I J L M N O P R S T U
jGCS Documentation

Copyright (c) 2006, Universidade de Lisboa
For updates and related information please see jGCS home page