|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jboss.netty.bootstrap.Bootstrap
public class Bootstrap
A helper class which initializes a Channel
. This class provides
the common data structure for its subclasses which actually initialize
Channel
s and their child Channel
s using the common data
structure. Please refer to ClientBootstrap
, ServerBootstrap
,
and ConnectionlessBootstrap
for client side, server-side, and
connectionless (e.g. UDP) channel initialization respectively.
Constructor Summary | |
---|---|
protected |
Bootstrap()
Creates a new instance with no ChannelFactory set. |
protected |
Bootstrap(ChannelFactory channelFactory)
Creates a new instance with the specified initial ChannelFactory . |
Method Summary | |
---|---|
ChannelFactory |
getFactory()
Returns the ChannelFactory that will be used to perform an
I/O operation. |
Object |
getOption(String key)
Returns the value of the option with the specified key. |
Map<String,Object> |
getOptions()
Returns the options which configures a new Channel and its
child Channel s. |
ChannelPipeline |
getPipeline()
Returns the default ChannelPipeline which is cloned when a new
Channel is created. |
Map<String,ChannelHandler> |
getPipelineAsMap()
Dependency injection friendly convenience method for getPipeline() which returns the default pipeline of this
bootstrap as an ordered map. |
ChannelPipelineFactory |
getPipelineFactory()
Returns the ChannelPipelineFactory which creates a new
ChannelPipeline for a new Channel . |
void |
releaseExternalResources()
Releases the external resources that this object depends on. |
void |
setFactory(ChannelFactory factory)
Sets the ChannelFactory that will be used to perform an I/O
operation. |
void |
setOption(String key,
Object value)
Sets an option with the specified key and value. |
void |
setOptions(Map<String,Object> options)
Sets the options which configures a new Channel and its child
Channel s. |
void |
setPipeline(ChannelPipeline pipeline)
Sets the default ChannelPipeline which is cloned when a new
Channel is created. |
void |
setPipelineAsMap(Map<String,ChannelHandler> pipelineMap)
Dependency injection friendly convenience method for setPipeline(ChannelPipeline) which sets the default pipeline of
this bootstrap from an ordered map. |
void |
setPipelineFactory(ChannelPipelineFactory pipelineFactory)
Sets the ChannelPipelineFactory which creates a new
ChannelPipeline for a new Channel . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected Bootstrap()
ChannelFactory
set.
setFactory(ChannelFactory)
must be called at once before any
I/O operation is requested.
protected Bootstrap(ChannelFactory channelFactory)
ChannelFactory
.
Method Detail |
---|
public ChannelFactory getFactory()
ChannelFactory
that will be used to perform an
I/O operation.
IllegalStateException
- if the factory is not set for this bootstrap yet.
The factory can be set in the constructor or
setFactory(ChannelFactory)
.public void setFactory(ChannelFactory factory)
ChannelFactory
that will be used to perform an I/O
operation. This method can be called only once and can't be called at
all if the factory was specified in the constructor.
IllegalStateException
- if the factory is already setpublic ChannelPipeline getPipeline()
ChannelPipeline
which is cloned when a new
Channel
is created. Bootstrap
creates a new pipeline
which has the same entries with the returned pipeline for a new
Channel
.
ChannelPipeline
IllegalStateException
- if setPipelineFactory(ChannelPipelineFactory)
was
called by a user last time.public void setPipeline(ChannelPipeline pipeline)
ChannelPipeline
which is cloned when a new
Channel
is created. Bootstrap
creates a new pipeline
which has the same entries with the specified pipeline for a new channel.
Calling this method also sets the pipelineFactory
property to an
internal ChannelPipelineFactory
implementation which returns
a shallow copy of the specified pipeline.
Please note that this method is a convenience method that works only
when 1) you create only one channel from this bootstrap (e.g.
one-time client-side or connectionless channel) or 2) the
ChannelPipelineCoverage
of all handlers in the pipeline is
"all"
. You have to use
setPipelineFactory(ChannelPipelineFactory)
if 1) your
pipeline contains a ChannelHandler
whose
ChannelPipelineCoverage
is "one"
and 2) one or
more channels are going to be created by this bootstrap (e.g. server-side
channels).
public Map<String,ChannelHandler> getPipelineAsMap()
getPipeline()
which returns the default pipeline of this
bootstrap as an ordered map.
IllegalStateException
- if setPipelineFactory(ChannelPipelineFactory)
was
called by a user last time.public void setPipelineAsMap(Map<String,ChannelHandler> pipelineMap)
setPipeline(ChannelPipeline)
which sets the default pipeline of
this bootstrap from an ordered map.
IllegalArgumentException
- if the specified map is not an ordered mappublic ChannelPipelineFactory getPipelineFactory()
ChannelPipelineFactory
which creates a new
ChannelPipeline
for a new Channel
.
getPipeline()
public void setPipelineFactory(ChannelPipelineFactory pipelineFactory)
ChannelPipelineFactory
which creates a new
ChannelPipeline
for a new Channel
. Calling this method
invalidates the current pipeline
property of this bootstrap.
Subsequent getPipeline()
and getPipelineAsMap()
calls
will raise IllegalStateException
.
setPipeline(ChannelPipeline)
,
setPipelineAsMap(Map)
public Map<String,Object> getOptions()
Channel
and its
child Channel
s. The names of the child Channel
options
are prepended with "child."
(e.g. "child.keepAlive"
).
public void setOptions(Map<String,Object> options)
Channel
and its child
Channel
s. To set the options of a child Channel
, prepend
"child."
to the option name (e.g. "child.keepAlive"
).
public Object getOption(String key)
Channel
, prepend "child."
to the option name (e.g. "child.keepAlive"
).
key
- the option name
null
otherwise.public void setOption(String key, Object value)
null
, an existing option with the specified
key is removed. To set the option value of a child Channel
,
prepend "child."
to the option name (e.g. "child.keepAlive"
).
key
- the option namevalue
- the option valuepublic void releaseExternalResources()
ChannelFactory.releaseExternalResources()
.
releaseExternalResources
in interface ExternalResourceReleasable
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |