Package com.microej.kf.util.control.net

Class WriteSocket

  • public class WriteSocket
extends AbstractSocket
    Action performed when writing on a socket.

    • Constructor Summary

      Constructors 
      Constructor Description
      WriteSocket​(java.net.Socket socket, int nbBytes)
      Creates a write socket action.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getNbBytes()
      Gets the number of bytes to be written.
      void onEnd​(boolean endWithSuccess)
      Called when the execution of the action is finished.
      void onStart()
      Called when the execution of the action is about to start.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • WriteSocket

        public WriteSocket​(java.net.Socket socket,
                   int nbBytes)
        Creates a write socket action.
        Parameters:
        socket - the socket of the write action.
        nbBytes - the number of written bytes.

    • Method Detail

      • getNbBytes

        public int getNbBytes()
        Gets the number of bytes to be written.
        Returns:
        the number of bytes to be written.

      • onStart

        public void onStart()
             throws java.lang.SecurityException
        Called when the execution of the action is about to start. This hook is used to check if the action is allowed to be performed.
        Throws:
        java.lang.SecurityException - if the action is not allowed to be performed.

      • onEnd

        public void onEnd​(boolean endWithSuccess)
        Called when the execution of the action is finished. This hook is used to update the current resources state of the module that performs the action.
        Parameters:
        endWithSuccess - true if the execution of the action was ended with success; false otherwise.