|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Conduit
Interface to a conduit.
Drains are registered and deregistered. Push drains will call the drain object from a system owned Thread. Pull drains are polled from outside the system Threads.
Version History
EPG - Adapted from autohit - 28 JUN 05
Nested Class Summary | |
---|---|
static class |
Conduit.InjectorType
The InjectorType specifies how it will behave, as follows: UNSPECIFIED: No preference. |
Field Summary | |
---|---|
static Nubblet |
NOTHING
A nothing nubblet is the same as a null. |
Method Summary | |
---|---|
void |
deRegisterPullDrain(PullDrainContainer theDrain)
Deregister a PullDrainContainer instance with the Conduit. |
void |
deRegisterPushDrain(PushDrain theDrain)
Deregister a PushDrain instance with the Conduit. |
void |
disposeInjector(Injector theInjector)
Explicitly dispose of an Injector. |
ConduitID |
getId()
Get the id. |
Injector |
getInjector(Conduit.InjectorType theType)
This will get an injector to the conduit. |
Injector |
getInjector(Conduit.InjectorType theType,
java.lang.String name)
This will get an injector to the conduit, named. |
void |
init(ConduitID yourId)
Initialize the Conduit. |
void |
registerPullDrain(PullDrainContainer theDrain)
Register a PullDrainContainer instance with the Conduit. |
void |
registerPushDrain(PushDrain theDrain)
Register a PushDrain instance with the Conduit. |
Field Detail |
---|
static final Nubblet NOTHING
Method Detail |
---|
void init(ConduitID yourId) throws SystemException
yourId
- The ConduitID.
SystemException
ConduitID
ConduitID getId()
Injector getInjector(Conduit.InjectorType theType) throws SystemException
theType
- The type of injector to get. If the underlying implementation does not support that type, it should throw a ThingsException.
SystemException
Injector getInjector(Conduit.InjectorType theType, java.lang.String name) throws SystemException
theType
- The type of injector to get. If the underlying implementation does not support that type, it should throw a ThingsException.name
- the name of the Injector.
SystemException
void disposeInjector(Injector theInjector) throws SystemException
theInjector
- The Injector object to dispose.
SystemException
void registerPullDrain(PullDrainContainer theDrain) throws SystemException
theDrain
- The drain to register.
SystemException
PullDrainContainer
void deRegisterPullDrain(PullDrainContainer theDrain) throws SystemException
theDrain
- The drain to deregister.
SystemException
PullDrainContainer
void registerPushDrain(PushDrain theDrain) throws SystemException
theDrain
- The drain to register.
SystemException
PushDrain
void deRegisterPushDrain(PushDrain theDrain) throws SystemException
theDrain
- The drain to deregister.
SystemException
PushDrain
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |