QKnxNetIpServerDiscoveryAgent Class

QKnxNetIpServerDiscoveryAgent agent;
QHostAddress clientLocalAddress = ...
agent.setLocalAddress(clientLocalAddress);
agent.start();

QHostAddress clientLocalAddress = ...
auto builder = QKnxNetIpSrpProxy::macAddressBuilder();

QKnxNetIpServerDiscoveryAgent agent(clientLocalAddress);
agent.setDiscoveryMode(QKnxNetIpServerDiscoveryAgent::DiscoveryMode::CoreV2);
agent.setExtendedSearchParameters({
    builder.setMac(QKnxByteArray::fromHex("bcaec56690f9")).create(),
    builder.setMac(QKnxByteArray::fromHex("4ccc6ae40000")).create()
});
agent.start();

auto servers = agent.discoveredServers();

Member Function Documentation

QKnxNetIpServerDiscoveryAgent::QKnxNetIpServerDiscoveryAgent(const QHostAddress &localAddress, quint16 port, QObject *parent = nullptr)

Creates a KNXnet/IP server discovery agent with the host address localAddress, the port number port, and the parent parent.

QKnxNetIpServerDiscoveryAgent::QKnxNetIpServerDiscoveryAgent(const QHostAddress &localAddress, QObject *parent = nullptr)

Creates a KNXnet/IP server discovery agent with the host address localAddress and the parent parent.

QKnxNetIpServerDiscoveryAgent::QKnxNetIpServerDiscoveryAgent(QObject *parent = nullptr)

Creates a KNXnet/IP server discovery agent with the parent parent.

[signal] void QKnxNetIpServerDiscoveryAgent::deviceDiscovered(QKnxNetIpServerInfo server)

This signal is emitted when the server server is discovered.

[signal] void QKnxNetIpServerDiscoveryAgent::errorOccurred(QKnxNetIpServerDiscoveryAgent::Error error, QString errorString)

This signal is emitted when the error error with the message errorString occurs.

[signal] void QKnxNetIpServerDiscoveryAgent::finished()

This signal is emitted when the discovery agent has finished discovering servers.

[slot] void QKnxNetIpServerDiscoveryAgent::start(QKnxNetIpServerDiscoveryAgent::InterfaceTypes types)

Starts a server discovery agent with the network interfaces specified by the list of interface types types.

[slot] void QKnxNetIpServerDiscoveryAgent::start(const QVector<QHostAddress> &addresses)

Starts a server discovery agent with the network interfaces specified by the list of local host addresses.

[slot] void QKnxNetIpServerDiscoveryAgent::start(int timeout)

Starts a server discovery agent with the timeout timeout.

See also setTimeout() and timeout().

[slot] void QKnxNetIpServerDiscoveryAgent::start()

Starts a server discovery agent.

[signal] void QKnxNetIpServerDiscoveryAgent::started()

This signal is emitted when the discovery agent starts discovering servers.

[signal] void QKnxNetIpServerDiscoveryAgent::stateChanged(QKnxNetIpServerDiscoveryAgent::State state)

This signal is emitted when the state of the discovery agent changes to state.

[slot] void QKnxNetIpServerDiscoveryAgent::stop()

Stops a server discovery agent.

[override virtual] QKnxNetIpServerDiscoveryAgent::~QKnxNetIpServerDiscoveryAgent()

Deletes a KNXnet/IP server discovery agent.

QVector<QKnxNetIpServerInfo> QKnxNetIpServerDiscoveryAgent::discoveredServers() const

Returns a list of servers that were discovered.

QKnxNetIpServerDiscoveryAgent::DiscoveryModes QKnxNetIpServerDiscoveryAgent::discoveryMode() const

Returns the search mode used to discover a KNXnet/IP server on the network and by default returns QKnxNetIpServerDiscoveryAgent::CoreV1.

This function was introduced in Qt 5.12.

See also setDiscoveryMode().

QKnxNetIpServerDiscoveryAgent::Error QKnxNetIpServerDiscoveryAgent::error() const

Returns the type of an error that occurred when discovering servers.

QString QKnxNetIpServerDiscoveryAgent::errorString() const

Returns a human-readable string that describes an error.

QVector<QKnxNetIpSrp> QKnxNetIpServerDiscoveryAgent::extendedSearchParameters() const

Returns the search request parameter (SRP) objects used in an extended search request.

This function was introduced in Qt 5.12.

See also setExtendedSearchParameters().

QHostAddress QKnxNetIpServerDiscoveryAgent::localAddress() const

Returns the host address of a discovery agent.

See also setLocalAddress().

quint16 QKnxNetIpServerDiscoveryAgent::localPort() const

Returns the port number used by a discovery agent.

See also setLocalPort().

quint8 QKnxNetIpServerDiscoveryAgent::multicastTtl() const

Returns the time to live (TTL) used for multicast search response messages. TTL is the maximum number of IP routers that may route the message. Each IP router that the message passes decrements the TTL by one. When the TTL has reached zero, the message is discarded.

See also setMulticastTtl().

bool QKnxNetIpServerDiscoveryAgent::natAware() const

Returns true if the server discovery agent uses network address translation (NAT).

See also setNatAware().

QKnxNetIpServerDiscoveryAgent::ResponseType QKnxNetIpServerDiscoveryAgent::responseType() const

Returns the response type of search response messages.

See also setResponseType().

int QKnxNetIpServerDiscoveryAgent::searchFrequency() const

Returns the frequency at which the discovery agent sends search request messages. The default value is 0.

See also setSearchFrequency.

void QKnxNetIpServerDiscoveryAgent::setDiscoveryMode(QKnxNetIpServerDiscoveryAgent::DiscoveryModes mode)

Sets the search mode used to discover a KNXnet/IP server on the network to mode. The function supports QKnxNetIpServerDiscoveryAgent::CoreV1, QKnxNetIpServerDiscoveryAgent::CoreV2, or a combination of both.

This function was introduced in Qt 5.12.

See also discoveryMode().

void QKnxNetIpServerDiscoveryAgent::setExtendedSearchParameters(const QVector<QKnxNetIpSrp> &srps)

Sets the extended search request parameter (SRP) objects to srps.

The discovery agent may include zero or more SRP objects to transfer additional information regarding the search (for example to restrict the set of KNXnet/IP servers that are expected to respond).

This function was introduced in Qt 5.12.

See also extendedSearchParameters(), QKnxNetIpSrpProxy::MacAddress, QKnxNetIpSrpProxy::ProgrammingMode, QKnxNetIpSrpProxy::SupportedFamily, and QKnxNetIpSrpProxy::RequestDibs.

void QKnxNetIpServerDiscoveryAgent::setLocalAddress(const QHostAddress &address)

Sets the host address of a discovery agent to address. To unset the local address use QHostAddress::Null.

See also localAddress().

void QKnxNetIpServerDiscoveryAgent::setLocalPort(quint16 port)

Sets the port number used by a discovery agent to port.

See also localPort().

void QKnxNetIpServerDiscoveryAgent::setMulticastTtl(quint8 ttl)

Sets the TTL used for multicasting to ttl. The value 1 means that the message does not leave the local network.

See also multicastTtl().

void QKnxNetIpServerDiscoveryAgent::setNatAware(bool useNat)

Sets whether the server discovery agent is using NAT to useNat.

See also natAware().

void QKnxNetIpServerDiscoveryAgent::setResponseType(QKnxNetIpServerDiscoveryAgent::ResponseType type)

Sets the response type of search response messages to type.

See also responseType().

void QKnxNetIpServerDiscoveryAgent::setSearchFrequency(int timesPerMinute)

Sets the frequency at which the discovery agent sends search request messages to timesPerMinute. The default value is 0.

See also timeout, setTimeout, and searchFrequency.

void QKnxNetIpServerDiscoveryAgent::setTimeout(int msec)

Sets the timeout for the discovery agent to msec. If msec is -1, the agent will not timeout and has to be terminated by calling the stop() function.

See also timeout, searchFrequency, and setSearchFrequency.

QKnxNetIpServerDiscoveryAgent::State QKnxNetIpServerDiscoveryAgent::state() const

Returns the state of a KNXnet/IP server discovery agent.

int QKnxNetIpServerDiscoveryAgent::timeout() const

Returns the timeout value used by the discovery agent to wait for incoming search response messages. The default value is 3000 milliseconds.

See also setTimeout.