ark_connection

ArkConnection

Bases: ABC

Source code in ark_sdk_python/common/connections/ark_connection.py

class ArkConnection(ABC):
    def __init__(self) -> None:
        self._logger = get_logger(self.__class__.__name__)

    @abstractmethod
    def connect(self, connection_details: ArkConnectionDetails) -> None:
        """
        Connects to the target with given information

        Args:
            connection_details (ArkConnectionDetails): _description_
        """

    @abstractmethod
    def disconnect(self) -> None:
        """
        Disconnects the active session
        """

    @abstractmethod
    def suspend_connection(self) -> None:
        """
        Suspends the session from command execution
        """

    @abstractmethod
    def restore_connection(self) -> None:
        """
        Restores the session
        """

    @abstractmethod
    def is_suspended(self) -> bool:
        """
        Checks whether session is suspended

        Returns:
            bool: _description_
        """

    @abstractmethod
    def is_connected(self) -> bool:
        """
        Checks whether session is connected

        Returns:
            bool: _description_
        """

    @abstractmethod
    def run_command(self, command: ArkConnectionCommand) -> ArkConnectionResult:
        """
        Runs a remote connection command

        Args:
            command (ArkConnectionCommand): _description_

        Returns:
            ArkConnectionResult: _description_
        """

connect(connection_details) abstractmethod

Connects to the target with given information

Parameters:

Name	Type	Description	Default
connection_details	ArkConnectionDetails	description	required

Source code in ark_sdk_python/common/connections/ark_connection.py

@abstractmethod
def connect(self, connection_details: ArkConnectionDetails) -> None:
    """
    Connects to the target with given information

    Args:
        connection_details (ArkConnectionDetails): _description_
    """

disconnect() abstractmethod

Disconnects the active session

Source code in ark_sdk_python/common/connections/ark_connection.py

@abstractmethod
def disconnect(self) -> None:
    """
    Disconnects the active session
    """

is_connected() abstractmethod

Checks whether session is connected

Returns:

Name	Type	Description
bool	bool	description

Source code in ark_sdk_python/common/connections/ark_connection.py

@abstractmethod
def is_connected(self) -> bool:
    """
    Checks whether session is connected

    Returns:
        bool: _description_
    """

is_suspended() abstractmethod

Checks whether session is suspended

Returns:

Name	Type	Description
bool	bool	description

Source code in ark_sdk_python/common/connections/ark_connection.py

@abstractmethod
def is_suspended(self) -> bool:
    """
    Checks whether session is suspended

    Returns:
        bool: _description_
    """

restore_connection() abstractmethod

Restores the session

Source code in ark_sdk_python/common/connections/ark_connection.py

@abstractmethod
def restore_connection(self) -> None:
    """
    Restores the session
    """

run_command(command) abstractmethod

Runs a remote connection command

Parameters:

Name	Type	Description	Default
command	ArkConnectionCommand	description	required

Returns:

Name	Type	Description
ArkConnectionResult	ArkConnectionResult	description

Source code in ark_sdk_python/common/connections/ark_connection.py

@abstractmethod
def run_command(self, command: ArkConnectionCommand) -> ArkConnectionResult:
    """
    Runs a remote connection command

    Args:
        command (ArkConnectionCommand): _description_

    Returns:
        ArkConnectionResult: _description_
    """

suspend_connection() abstractmethod

Suspends the session from command execution

Source code in ark_sdk_python/common/connections/ark_connection.py

@abstractmethod
def suspend_connection(self) -> None:
    """
    Suspends the session from command execution
    """