[CONF] Apache MINA > IoService introduction

[confluence]

IoService introduction Page edited by Emmanuel Lécharny Changes (4) ... h3. getTransportMetadata() This method returns the Transport meta-data the Acceptor or Connector is running. The typical details include provider name (nio, apr, rxtx), connection type (connectionless/connection oriented) etc. h3. addListener Allows to add a IoServiceListener to listen to specific events related to Ioservice. h3. removeListener Removes specified IoServiceListener attached to this IoService. h3. isDisposing This method tells if the service is currently being disposed. As it can take a while, it's useful to know the current status of the service. h3. isDisposed This method tells if the service has been disposed. A service will be considered as disposed only when all the resources it has allocated have been released. h3. dispose This method releases all the resources the service has allocated. As it may take a while, the user should check the service status using the isDisposing() and isDisposed() to know if the service is now disposed completely. Always call dispose() when you shutdown a service ! h3. getHandler Returns the IoHandler associated with the service. h3. setHandler Sets the IoHandler that will be responsible for handling all the events for the service. The handler contains your application logic ! h3. getManagedSessions Returns the map of all sessions which are currently managed by this service. A managed session is a session which is added to the service listener. It will be used to process the idle sessions, and other session aspects, depending on the kind of listeners a user adds to a service. h3. getManagedSessionCount Returns the number of all sessions which are currently managed by this service. h3. getSessionConfig Returns the session configuration. h3. getFilterChainBuilder Returns the Filter chain builder. This is useful if one wants to add some new filter that will be injected when the sessions will be created. h3. setFilterChainBuilder Defines the Filter chain builder to use with the service. h3. getFilterChain Returns the current default Filter chain for the service. h3. isActive Tells if the service is active or not. h3. getActivationTime Returns the time when this service was activated. It returns the last time when this service was activated if the service is not anymore active. h3. broadcast Writes the given message to all the managed sessions. h3. setSessionDataStructureFactory Sets the IoSessionDataStructureFactory that provides related data structures for a new session created by this service. h3. getScheduledWriteBytes Returns the number of bytes scheduled to be written (ie, the bytes stored in memory waiting for the socket to be ready for write). h3. getScheduledWriteMessages Returns the number of messages scheduled to be written (ie, the messages stored in memory waiting for the socket to be ready for write). h3. getStatistics Returns the IoServiceStatistics object for this service. Full Content   Chapter 3 - Service  IO Service note This page is being updated Overview IoService provides basic I/O Service and manages I/O Sessions within MINA. Its one of the most crucial part of MINA Architecture. The implementing classes of IoService and child interface, are where most of the low level I/O operations are handled. IoService Mind Map Lets try to see what are the responsibilities of the IoService and it implementing class AbstractIoService. Lets take a slightly different approach of first using a Ming Map and then jump into the inner working. The Mind Map was created using XMind. Interface Details IoService is the base interface for all the IoConnector's and IoAcceptor's that provides I/O services and manages I/O sessions. The interface has all the functions need to perform I/O related operations. Lets take a deep dive into the various methods in the interface getTransportMetadata() addListener() removeListener() isDisposing() isDisposed() dispose() getHandler() setHandler() getManagedSessions() getManagedSessionCount() getSessionConfig() getFilterChainBuilder() setFilterChainBuilder() getFilterChain() isActive() getActivationTime() broadcast() setSessionDataStructureFactory() getScheduledWriteBytes() getScheduledWriteMessages() getStatistics() getTransportMetadata() This method returns the Transport meta-data the Acceptor or Connector is running. The typical details include provider name (nio, apr, rxtx), connection type (connectionless/connection oriented) etc. addListener Allows to add a IoServiceListener to listen to specific events related to Ioservice. removeListener Removes specified IoServiceListener attached to this IoService. isDisposing This method tells if the service is currently being disposed. As it can take a while, it's useful to know the current status of the service. isDisposed This method tells if the service has been disposed. A service will be considered as disposed only when all the resources it has allocated have been released. dispose This method releases all the resources the service has allocated. As it may take a while, the user should check the service status using the isDisposing() and isDisposed() to know if the service is now disposed completely. Always call dispose() when you shutdown a service ! getHandler Returns the IoHandler associated with the service. setHandler Sets the IoHandler that will be responsible for handling all the events for the service. The handler contains your application logic ! getManagedSessions Returns the map of all sessions which are currently managed by this service. A managed session is a session which is added to the service listener. It will be used to process the idle sessions, and other session aspects, depending on the kind of listeners a user adds to a service. getManagedSessionCount Returns the number of all sessions which are currently managed by this service. getSessionConfig Returns the session configuration. getFilterChainBuilder Returns the Filter chain builder. This is useful if one wants to add some new filter that will be injected when the sessions will be created. setFilterChainBuilder Defines the Filter chain builder to use with the service. getFilterChain Returns the current default Filter chain for the service. isActive Tells if the service is active or not. getActivationTime Returns the time when this service was activated. It returns the last time when this service was activated if the service is not anymore active. broadcast Writes the given message to all the managed sessions. setSessionDataStructureFactory Sets the IoSessionDataStructureFactory that provides related data structures for a new session created by this service. getScheduledWriteBytes Returns the number of bytes scheduled to be written (ie, the bytes stored in memory waiting for the socket to be ready for write). getScheduledWriteMessages Returns the number of messages scheduled to be written (ie, the messages stored in memory waiting for the socket to be ready for write). getStatistics Returns the IoServiceStatistics object for this service. Change Notification Preferences View Online | View Changes | Add Comment