Module pantools.TCPClient

Expand source code
import struct
import socket
import pickle
import threading
from _thread import *
import queue
from pantools.net import announce_service, wait_for_announcement
import time

from .logger import logger
from .send_recv import send_json, send_size, recv_size

# ================================================================
#
# ================================================================
class TCPClient:

    # ------------------------------------------------------------
    # listen for advertisements on port XYZ, listen for ABC keyword
    # ------------------------------------------------------------
    def __init__(self, magic, port) -> None:
        self.sock = None
        self.adv_magic = magic
        self.adv_port = port
        
        self.inq = queue.Queue(10000)
        self.outq = queue.Queue(10000)

        self.quit_write_thread = False
        self.quit_read_thread = False

    # ------------------------------------------------------------
    # If you dont know the service ip/port, use the advertisement!
    # ------------------------------------------------------------
    def start_client(self):
        logger.info("start_client. waiting for announcement before connecting...")
        (service_host, service_port) = wait_for_announcement(self.adv_port, self.adv_magic)
        logger.info("start_client. got announcement: {} {}".format(service_host, service_port))
        self.connect_to_service(service_host, service_port)

    # ------------------------------------------------------------
    # Connect and start a reader loop.
    # ------------------------------------------------------------
    def connect_to_service(self, ip, port):
        self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
        try:
            logger.info("Connecting to: {}:{}".format(ip, port))
            self.sock.connect((ip, port))
            logger.info("Connected! - Starting worker threads")
            self.handle_connection_status("connected")
            
            start_new_thread(self.write_thread, ())
            start_new_thread(self.read_thread, ())

        except Exception as e:
            logger.error("Got an exception {} trying to connect".format(str(e)))
            self.handle_connection_status("disconnected")

        logger.debug("Exiting connect_to_service()")


    # ------------------------------------------------------------
    #
    # ------------------------------------------------------------
    def read_thread(self):
        logger.debug("+++ ENTR +++ read_thread()")
        try:
            cont = True
            while cont:
                try:
                    msg_encoded = recv_size(self.sock)
                    msg = pickle.loads(msg_encoded)
                    self.handle_message(msg)
                except Exception as e:
                    logger.error("Exception in read_thread...")
                    logger.error(str(e))
                    self.handle_exception(e)
                    cont = False
        finally:
            logger.debug("Closing socket from read_thread...")
            self.sock.close()
            logger.debug("+++ EXIT +++ read_thread()")
            self.handle_connection_status("disconnected")

    # ------------------------------------------------------------
    #
    # ------------------------------------------------------------
    def write_thread(self):
        logger.debug("+++ ENTR +++ write_thread()")
        while (not self.quit_write_thread):
            out_msg = self.outq.get(block=True)

            try:
                send_size(self.sock, out_msg)
            except Exception as e:
                self.handle_exception(e)
                logger.error(f"Exception: {e} - exiting write thread")
                return


    # ------------------------------------------------------------
    #
    # ------------------------------------------------------------
    def handle_message(self, msg):
        self.inq.put(msg)


    # ------------------------------------------------------------
    #
    # ------------------------------------------------------------
    def handle_exception(self, e):
        msg = {
            "message": "exception",
            "msgtype": "event",
            "exception": e
        }
        self.inq.put(msg)

    # ------------------------------------------------------------
    #
    # ------------------------------------------------------------
    def handle_connection_status(self, status):
        msg = {
            "message": "connection_status",
            "msgtype": "event",
            "status": status
        }
        self.inq.put(msg)

    #
    #
    #
    def subscribe(self, msgtype):

        # send a subscription message
        self.send_msg({
                "message": "subscribe",
                "msgtype": msgtype,
                "type": "json-object",
                "threadname": "none",
                "hostname": socket.gethostname()
            })


    def send_msg(self, msg_json):
        msg_encoded = pickle.dumps(msg_json)
        self.outq.put(msg_encoded)

    def read_msg(self):
        m = self.inq.get(block=True)
        return m
        

Classes

class TCPClient (magic, port)
Expand source code
class TCPClient:

    # ------------------------------------------------------------
    # listen for advertisements on port XYZ, listen for ABC keyword
    # ------------------------------------------------------------
    def __init__(self, magic, port) -> None:
        self.sock = None
        self.adv_magic = magic
        self.adv_port = port
        
        self.inq = queue.Queue(10000)
        self.outq = queue.Queue(10000)

        self.quit_write_thread = False
        self.quit_read_thread = False

    # ------------------------------------------------------------
    # If you dont know the service ip/port, use the advertisement!
    # ------------------------------------------------------------
    def start_client(self):
        logger.info("start_client. waiting for announcement before connecting...")
        (service_host, service_port) = wait_for_announcement(self.adv_port, self.adv_magic)
        logger.info("start_client. got announcement: {} {}".format(service_host, service_port))
        self.connect_to_service(service_host, service_port)

    # ------------------------------------------------------------
    # Connect and start a reader loop.
    # ------------------------------------------------------------
    def connect_to_service(self, ip, port):
        self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
        try:
            logger.info("Connecting to: {}:{}".format(ip, port))
            self.sock.connect((ip, port))
            logger.info("Connected! - Starting worker threads")
            self.handle_connection_status("connected")
            
            start_new_thread(self.write_thread, ())
            start_new_thread(self.read_thread, ())

        except Exception as e:
            logger.error("Got an exception {} trying to connect".format(str(e)))
            self.handle_connection_status("disconnected")

        logger.debug("Exiting connect_to_service()")


    # ------------------------------------------------------------
    #
    # ------------------------------------------------------------
    def read_thread(self):
        logger.debug("+++ ENTR +++ read_thread()")
        try:
            cont = True
            while cont:
                try:
                    msg_encoded = recv_size(self.sock)
                    msg = pickle.loads(msg_encoded)
                    self.handle_message(msg)
                except Exception as e:
                    logger.error("Exception in read_thread...")
                    logger.error(str(e))
                    self.handle_exception(e)
                    cont = False
        finally:
            logger.debug("Closing socket from read_thread...")
            self.sock.close()
            logger.debug("+++ EXIT +++ read_thread()")
            self.handle_connection_status("disconnected")

    # ------------------------------------------------------------
    #
    # ------------------------------------------------------------
    def write_thread(self):
        logger.debug("+++ ENTR +++ write_thread()")
        while (not self.quit_write_thread):
            out_msg = self.outq.get(block=True)

            try:
                send_size(self.sock, out_msg)
            except Exception as e:
                self.handle_exception(e)
                logger.error(f"Exception: {e} - exiting write thread")
                return


    # ------------------------------------------------------------
    #
    # ------------------------------------------------------------
    def handle_message(self, msg):
        self.inq.put(msg)


    # ------------------------------------------------------------
    #
    # ------------------------------------------------------------
    def handle_exception(self, e):
        msg = {
            "message": "exception",
            "msgtype": "event",
            "exception": e
        }
        self.inq.put(msg)

    # ------------------------------------------------------------
    #
    # ------------------------------------------------------------
    def handle_connection_status(self, status):
        msg = {
            "message": "connection_status",
            "msgtype": "event",
            "status": status
        }
        self.inq.put(msg)

    #
    #
    #
    def subscribe(self, msgtype):

        # send a subscription message
        self.send_msg({
                "message": "subscribe",
                "msgtype": msgtype,
                "type": "json-object",
                "threadname": "none",
                "hostname": socket.gethostname()
            })


    def send_msg(self, msg_json):
        msg_encoded = pickle.dumps(msg_json)
        self.outq.put(msg_encoded)

    def read_msg(self):
        m = self.inq.get(block=True)
        return m

Methods

def connect_to_service(self, ip, port)
Expand source code
def connect_to_service(self, ip, port):
    self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
    try:
        logger.info("Connecting to: {}:{}".format(ip, port))
        self.sock.connect((ip, port))
        logger.info("Connected! - Starting worker threads")
        self.handle_connection_status("connected")
        
        start_new_thread(self.write_thread, ())
        start_new_thread(self.read_thread, ())

    except Exception as e:
        logger.error("Got an exception {} trying to connect".format(str(e)))
        self.handle_connection_status("disconnected")

    logger.debug("Exiting connect_to_service()")
def handle_connection_status(self, status)
Expand source code
def handle_connection_status(self, status):
    msg = {
        "message": "connection_status",
        "msgtype": "event",
        "status": status
    }
    self.inq.put(msg)
def handle_exception(self, e)
Expand source code
def handle_exception(self, e):
    msg = {
        "message": "exception",
        "msgtype": "event",
        "exception": e
    }
    self.inq.put(msg)
def handle_message(self, msg)
Expand source code
def handle_message(self, msg):
    self.inq.put(msg)
def read_msg(self)
Expand source code
def read_msg(self):
    m = self.inq.get(block=True)
    return m
def read_thread(self)
Expand source code
def read_thread(self):
    logger.debug("+++ ENTR +++ read_thread()")
    try:
        cont = True
        while cont:
            try:
                msg_encoded = recv_size(self.sock)
                msg = pickle.loads(msg_encoded)
                self.handle_message(msg)
            except Exception as e:
                logger.error("Exception in read_thread...")
                logger.error(str(e))
                self.handle_exception(e)
                cont = False
    finally:
        logger.debug("Closing socket from read_thread...")
        self.sock.close()
        logger.debug("+++ EXIT +++ read_thread()")
        self.handle_connection_status("disconnected")
def send_msg(self, msg_json)
Expand source code
def send_msg(self, msg_json):
    msg_encoded = pickle.dumps(msg_json)
    self.outq.put(msg_encoded)
def start_client(self)
Expand source code
def start_client(self):
    logger.info("start_client. waiting for announcement before connecting...")
    (service_host, service_port) = wait_for_announcement(self.adv_port, self.adv_magic)
    logger.info("start_client. got announcement: {} {}".format(service_host, service_port))
    self.connect_to_service(service_host, service_port)
def subscribe(self, msgtype)
Expand source code
def subscribe(self, msgtype):

    # send a subscription message
    self.send_msg({
            "message": "subscribe",
            "msgtype": msgtype,
            "type": "json-object",
            "threadname": "none",
            "hostname": socket.gethostname()
        })
def write_thread(self)
Expand source code
def write_thread(self):
    logger.debug("+++ ENTR +++ write_thread()")
    while (not self.quit_write_thread):
        out_msg = self.outq.get(block=True)

        try:
            send_size(self.sock, out_msg)
        except Exception as e:
            self.handle_exception(e)
            logger.error(f"Exception: {e} - exiting write thread")
            return