ControlPort Class Reference

#include <control_port.hpp>

Inheritance diagram for ControlPort:

Collaboration diagram for ControlPort:

Public Types
using	LineCallback = std::function<void(std::string_view)>

Signals
void	connected ()
void	disconnected ()

Public Member Functions
	ControlPort ()
	~ControlPort ()=default
void	addLineCallback (LineCallback callback)
void	connect (int local_port)
QAbstractSocket::SocketState	getState () const
void	parseLine (std::string_view line)
void	writeLine (std::string_view line)

Private Slots
void	readReady ()

Private Attributes
LineBuffer	lineBuf
std::vector< LineCallback >	lineCallbacks
QTcpSocket	socket

Detailed Description

Definition at line 13 of file control_port.hpp.

Member Typedef Documentation

LineCallback

using ControlPort::LineCallback = std::function<void(std::string_view)>

Definition at line 26 of file control_port.hpp.

Constructor & Destructor Documentation

ControlPort()

ControlPort::ControlPort

(

)

Definition at line 7 of file control_port.cpp.

                        {
        QObject::connect(&socket, &QTcpSocket::readyRead, this, &ControlPort::readReady);
 
        QObject::connect(&socket, &QTcpSocket::connected, this, &ControlPort::connected);
        QObject::connect(&socket, &QTcpSocket::disconnected, this, &ControlPort::disconnected);
}

References connected(), disconnected(), readReady(), and socket.

Here is the call graph for this function:

~ControlPort()

ControlPort::~ControlPort ( )

default

Member Function Documentation

addLineCallback()

void ControlPort::addLineCallback ( LineCallback callback )

inline

Definition at line 27 of file control_port.hpp.

{ lineCallbacks.push_back(callback); }

References callback, and lineCallbacks.

Referenced by UltragridWindow::UltragridWindow(), and VuMeterWidget::setControlPort().

connect()

void ControlPort::connect

(

int

local_port

)

Definition at line 14 of file control_port.cpp.

                                       {
        /* Prevents failure in case the socket is alredy connecting. This also
         * discards pending data in the send buffer, but we don't care about
         * that.*/
        socket.abort();
 
        socket.connectToHost(QHostAddress::LocalHost, local_port);
}

References socket.

Referenced by parseLine().

connected

void ControlPort::connected ( )

signal

Referenced by ControlPort(), and VuMeterWidget::setControlPort().

disconnected

void ControlPort::disconnected ( )

signal

Referenced by ControlPort().

getState()

QAbstractSocket::SocketState ControlPort::getState

(

)

const

Definition at line 35 of file control_port.cpp.

                                                      {
        return socket.state();
}

References socket.

Referenced by VuMeterWidget::updateVal().

parseLine()

void ControlPort::parseLine

(

std::string_view

line

)

Definition at line 23 of file control_port.cpp.

                                              {
        constexpr std::string_view prefix = "Control socket listening on port";
        if(line.substr(0, prefix.length()) != prefix)
                return;
 
        auto tmp = std::string(line.substr(prefix.length()));
        int port = 0;
        sscanf(tmp.c_str(), " %d", &port);
 
        connect(port);
}

References connect().

Here is the call graph for this function:

readReady

void ControlPort::readReady ( )

privateslot

Definition at line 52 of file control_port.cpp.

                           {
        char buf[512];
 
        while(true){
                int ret = socket.read(buf, sizeof(buf));
                if(ret == 0 || ret == -1)
                        break;
 
                lineBuf.write(std::string_view(buf, ret));
 
                while(lineBuf.hasLine()){
                        for(auto& c : lineCallbacks){
                                c(lineBuf.peek());
                        }
                        lineBuf.pop();
                }
        }
}

References LineBuffer::hasLine(), lineBuf, lineCallbacks, LineBuffer::peek(), LineBuffer::pop(), socket, and LineBuffer::write().

Referenced by ControlPort().

Here is the call graph for this function:

writeLine()

void ControlPort::writeLine

(

std::string_view

line

)

Definition at line 39 of file control_port.cpp.

                                              {
        int toWrite = line.length();
        const char *data = line.data();
        while(toWrite > 0){
                auto ret = socket.write(data, toWrite);
                if(ret < 0){
                        break;
                }
                data += ret;
                toWrite -= ret;
        }
}

References socket.

Referenced by VuMeterWidget::onControlPortConnect().

Member Data Documentation

lineBuf

LineBuffer ControlPort::lineBuf

private

Definition at line 38 of file control_port.hpp.

Referenced by readReady().

lineCallbacks

std::vector<LineCallback> ControlPort::lineCallbacks

private

Definition at line 39 of file control_port.hpp.

Referenced by addLineCallback(), and readReady().

socket

QTcpSocket ControlPort::socket

private

Definition at line 37 of file control_port.hpp.

Referenced by ControlPort(), connect(), getState(), readReady(), and writeLine().

---

The documentation for this class was generated from the following files:

• gui/QT/util/control_port.hpp
• gui/QT/util/control_port.cpp