1

"""

     2

    Abstract Service interface

     3

"""

     4

     5

class ServiceError (Exception) :

     6

    """

     7

        Service-related error.

     8

    """

     9

    10

class Service (object) :

    11

    """

    12

        A Service listens for incoming connections, handing those connections off as separate objects.

    13

    14

        This is an abstract base class that is further impemented by e.g. TCP or SSL.

    15

    """

    16

    17

    def __init__ (self, endpoint) :

    18

        """

    19

            Listen on the given local endpoint.

    20

    21

                endpoint    - the local Endpoint to provide this service on.

    22

        """

    23

    24

        raise NotImplementedError()

    25

    26

    def accept (self, cls=None) :

    27

        """

    28

            Accept and return a new Transport object representing a connected remote Client.

    29

    30

                cls         - optional transport-specific type to use for the new connection.

    31

        """

    32

    33

        raise NotImplementedError()

    34

    35

    def close (self) :

    36

        """

    37

            Explicitly shut down this Service, closing any underlying resources and refusing any new connections.

    38

    39

            This will happen implicitly if the Service is destroyed, this is just the explicit interface.

    40

    41

            This invalidates this Service object for future use.

    42

    43

            This may, in theory, raise an error, which would be supressed if this Service were destroyed.

    44

        """

    45

    46

        raise NotImplementedError()

    47