Ferreteria/v0.6/clade/IO/Aspect/Connx

clade: IO\Aspect\Connx

Clade Family Aspect → Connx → Buffer Plug Process Clade Aliases Alias Clade Base* [ca,i,t] IO\Aspect Action* [c,i] Sys\Events\ItWent SelfIface IO\Aspect\Connx Subpages Buffer Buffer/@fx/RemoveBytes Buffer/@fx/RestoreBytes Buffer/@removed Buffer/File Buffer/File/Reader Buffer/File/Reader/@fx/RemoveBytes Buffer/File/Reader/Text Buffer/File/Writer Buffer/InMem Buffer/Sourced/File Buffer/Sourced/File/Reader Buffer/Sourced/File/Reader/@fx/RemoveBytes Buffer/Sourced/File/Writer Plug Plug/Chain Plug/Shell Plug/Shell/@removed Plug/Shell/Local Plug/Shell/Remote Plug/Shell/Remote/SSH Plug/Shell/Remote/SSH/@fx/DoCommand Plug/Shell/Remote/SSH/@removed Process Process/@fx/Convey Process/@fx/PipeToStream Process/@fx/Run Process/@fx/Send Process/@fx/StreamToPipe Process/@removed Stream Stream/Buffer Stream/Finite Stream/Finite/Buffer Stream/Native Stream/Native/File Stream/Native/File/Text aux aux/QStream aux/Tunnel

About

• Purpose: encapsulates a connection to a Socket (...I think...)
• Services:
  • keeps track of how many requests there are for a thing to be open
  • internally requests the actual opening and closing as needed (when req-qty changes to/from zero)

Subspaces

• aux
• Buffer
• Plug

History

• 2024-11-28 extracted relevant code from ssh/Shell so that Buffer and fsys/Node could use it too.
• 2025-03-28 moved from [WFe]IO\Connx\Aux\xOpener -> [WFe]IO\xConnx; added Base clade, caConnx
• 2025-05-27 moved from [WFe]IO ⇒ [WFe]IO\Aspect; correspondingly re-parented

Code

as of 2025-10-22

interface iConnx extends BaseIface {
    // LIFECYCLE
    function IsOpen() : bool;
    function Open() : ActionIface;
    function Shut() : ActionIface;
}

trait tConnx {
    use BaseTrait;

    abstract protected function ActualOpen() : ActionIface;
    abstract protected function ActualShut() : ActionIface;

    private int $nOpens = 0;
    public function IsOpen() : bool { return $this->nOpens > 0; }
    private $oAct;  // 2025-04-12 For now, this only saves the status of the ActualOpen() operation, not ActualShut().
    public function ItWent() : ActionIface { return $this->oAct; }
    public function Open() : ActionIface {
        $nOpens = $this->nOpens++;
        #echo get_called_class()." OPENS: [$nOpens]".CRLF;
        if ($nOpens === 0) {
            #echo ' - actual open:'.CRLF;
            $oAct = $this->ActualOpen();
            $this->oAct = $oAct;
            #echo ' - - $oAct class: '.get_class($oAct).CRLF;
        } else {
            #echo ' - opening existing $oAct'.CRLF;
            // Report results of actual open, which happened earlier.
            $oAct = $this->oAct;
        }
        return $oAct;
    }
    public function Shut() : ActionIface {
        $nOpens = --$this->nOpens;
        if ($nOpens == 0) {
            $oAct = $this->ActualShut();
        } else {
            $oAct = new ActionClass;
            $oAct->SetNoOp();
            // Only the final/real Shut() actually does anything.
        }
        return $oAct;
    }
}
abstract class caConnx extends BaseClass implements SelfIface {
    use tConnx;
}