boswatch.network.netCheck.NetCheck Class Reference

Worker class to check internet connection. More...

Public Member Functions
	__init__ (self, hostname="https://www.google.com/", timeout=1)
	Create a new NetCheck instance.
	checkConn (self)
	Check the connection.

Data Fields
	connectionState

Protected Attributes
	_hostname
	_timeout

Detailed Description

Worker class to check internet connection.

Constructor & Destructor Documentation

__init__()

boswatch.network.netCheck.NetCheck.__init__	(		self,
			hostname = "https://www.google.com/",
			timeout = 1
	)

Create a new NetCheck instance.

Parameters

hostname	host against connection check is running ("https://www.google.com/")
timeout	timeout for connection check in sec. (1)

    def __init__(self, hostname="https://www.google.com/", timeout=1):
        r"""!Create a new NetCheck instance
 
        @param hostname: host against connection check is running ("https://www.google.com/")
        @param timeout: timeout for connection check in sec. (1)"""
        self._hostname = hostname
        self._timeout = timeout
        self.connectionState = False
        self.checkConn()  # initiate a first check
 

Member Function Documentation

checkConn()

boswatch.network.netCheck.NetCheck.checkConn

(

self

)

Check the connection.

Returns

True or False

    def checkConn(self):
        r"""!Check the connection
 
        @return True or False"""
        try:
            urlopen(self._hostname, timeout=self._timeout)
            logging.debug("%s is reachable", self._hostname)
            self.connectionState = True
            return True
        except:  # todo find right exception type
            logging.warning("%s is not reachable", self._hostname)
            self.connectionState = False
            return False

Field Documentation

_hostname

boswatch.network.netCheck.NetCheck._hostname

protected

_timeout

boswatch.network.netCheck.NetCheck._timeout

protected

connectionState

boswatch.network.netCheck.NetCheck.connectionState