KLayout Documentation (Qt 5): Main Index » Class Index » API reference - Class QNetworkSession

API reference - Class QNetworkSession

Notation used in Ruby API documentation

Module: QtNetwork

Description: Binding of QNetworkSession

Class hierarchy: QNetworkSession » QObject

Sub-classes: SessionError, QFlags_SessionError, State, QFlags_State, UsagePolicy, QFlags_UsagePolicy

Public constructors
Public methods
Public static methods and constants
Protected methods (static, non-static and constructors)
Detailed description

Public constructors

new QNetworkSession

new

(const QNetworkConfiguration connConfig,
QObject ptr parent = nullptr)

Constructor QNetworkSession::QNetworkSession(const QNetworkConfiguration &connConfig, QObject *parent)

Public methods

	void	_create		Ensures the C++ object is created
	void	_destroy		Explicitly destroys the object
[const]	bool	_destroyed?		Returns a value indicating whether the object was already destroyed
[const]	bool	_is_const_object?		Returns a value indicating whether the reference is a const reference
	void	_manage		Marks the object as managed by the script side.
	void	_unmanage		Marks the object as no longer owned by the script side.
	void	accept		Method void QNetworkSession::accept()
[const]	unsigned long long	activeTime		Method quint64 QNetworkSession::activeTime()
[const]	unsigned long long	bytesReceived		Method quint64 QNetworkSession::bytesReceived()
[const]	unsigned long long	bytesWritten		Method quint64 QNetworkSession::bytesWritten()
	void	close		Method void QNetworkSession::close()
[signal]	void	closed		Signal declaration for QNetworkSession::closed()
[const]	QNetworkConfiguration	configuration		Method QNetworkConfiguration QNetworkSession::configuration()
[signal]	void	destroyed	(QObject ptr arg1)	Signal declaration for QNetworkSession::destroyed(QObject *)
	void	emit_closed		Emitter for signal void QNetworkSession::closed()
	void	emit_destroyed	(QObject ptr arg1 = nullptr)	Emitter for signal void QNetworkSession::destroyed(QObject *)
	void	emit_error_sig	(const QNetworkSession_SessionError arg1)	Emitter for signal void QNetworkSession::error(QNetworkSession::SessionError)
	void	emit_newConfigurationActivated		Emitter for signal void QNetworkSession::newConfigurationActivated()
	void	emit_objectNameChanged	(string objectName)	Emitter for signal void QNetworkSession::objectNameChanged(const QString &objectName)
	void	emit_opened		Emitter for signal void QNetworkSession::opened()
	void	emit_preferredConfigurationChanged	(const QNetworkConfiguration config, bool isSeamless)	Emitter for signal void QNetworkSession::preferredConfigurationChanged(const QNetworkConfiguration &config, bool isSeamless)
	void	emit_stateChanged	(const QNetworkSession_State arg1)	Emitter for signal void QNetworkSession::stateChanged(QNetworkSession::State)
	void	emit_usagePoliciesChanged	(QNetworkSession_QFlags_UsagePolicy usagePolicies)	Emitter for signal void QNetworkSession::usagePoliciesChanged(QFlags<QNetworkSession::UsagePolicy> usagePolicies)
[const]	QNetworkSession_SessionError	error		Method QNetworkSession::SessionError QNetworkSession::error()
[const]	string	errorString		Method QString QNetworkSession::errorString()
[signal]	void	error_sig	(const QNetworkSession_SessionError arg1)	Signal declaration for QNetworkSession::error(QNetworkSession::SessionError)
	bool	event	(QEvent ptr event)	Virtual method bool QNetworkSession::event(QEvent *event)
	bool	eventFilter	(QObject ptr watched, QEvent ptr event)	Virtual method bool QNetworkSession::eventFilter(QObject watched, QEvent event)
	void	ignore		Method void QNetworkSession::ignore()
[const]	QNetworkInterface	interface		Method QNetworkInterface QNetworkSession::interface()
[const]	bool	isOpen?		Method bool QNetworkSession::isOpen()
	void	migrate		Method void QNetworkSession::migrate()
[signal]	void	newConfigurationActivated		Signal declaration for QNetworkSession::newConfigurationActivated()
[signal]	void	objectNameChanged	(string objectName)	Signal declaration for QNetworkSession::objectNameChanged(const QString &objectName)
	void	open		Method void QNetworkSession::open()
[signal]	void	opened		Signal declaration for QNetworkSession::opened()
[signal]	void	preferredConfigurationChanged	(const QNetworkConfiguration config, bool isSeamless)	Signal declaration for QNetworkSession::preferredConfigurationChanged(const QNetworkConfiguration &config, bool isSeamless)
	void	reject		Method void QNetworkSession::reject()
[const]	variant	sessionProperty	(string key)	Method QVariant QNetworkSession::sessionProperty(const QString &key)
	void	setSessionProperty	(string key, variant value)	Method void QNetworkSession::setSessionProperty(const QString &key, const QVariant &value)
[const]	QNetworkSession_State	state		Method QNetworkSession::State QNetworkSession::state()
[signal]	void	stateChanged	(const QNetworkSession_State arg1)	Signal declaration for QNetworkSession::stateChanged(QNetworkSession::State)
	void	stop		Method void QNetworkSession::stop()
[const]	QNetworkSession_QFlags_UsagePolicy	usagePolicies		Method QFlags<QNetworkSession::UsagePolicy> QNetworkSession::usagePolicies()
[signal]	void	usagePoliciesChanged	(QNetworkSession_QFlags_UsagePolicy usagePolicies)	Signal declaration for QNetworkSession::usagePoliciesChanged(QFlags<QNetworkSession::UsagePolicy> usagePolicies)
	bool	waitForOpened	(int msecs = 30000)	Method bool QNetworkSession::waitForOpened(int msecs)

Public static methods and constants

[static,const]	QNetworkSession_State	Closing		Enum constant QNetworkSession::Closing
[static,const]	QNetworkSession_State	Connected		Enum constant QNetworkSession::Connected
[static,const]	QNetworkSession_State	Connecting		Enum constant QNetworkSession::Connecting
[static,const]	QNetworkSession_State	Disconnected		Enum constant QNetworkSession::Disconnected
[static,const]	QNetworkSession_State	Invalid		Enum constant QNetworkSession::Invalid
[static,const]	QNetworkSession_SessionError	InvalidConfigurationError		Enum constant QNetworkSession::InvalidConfigurationError
[static,const]	QNetworkSession_UsagePolicy	NoBackgroundTrafficPolicy		Enum constant QNetworkSession::NoBackgroundTrafficPolicy
[static,const]	QNetworkSession_UsagePolicy	NoPolicy		Enum constant QNetworkSession::NoPolicy
[static,const]	QNetworkSession_State	NotAvailable		Enum constant QNetworkSession::NotAvailable
[static,const]	QNetworkSession_SessionError	OperationNotSupportedError		Enum constant QNetworkSession::OperationNotSupportedError
[static,const]	QNetworkSession_State	Roaming		Enum constant QNetworkSession::Roaming
[static,const]	QNetworkSession_SessionError	RoamingError		Enum constant QNetworkSession::RoamingError
[static,const]	QNetworkSession_SessionError	SessionAbortedError		Enum constant QNetworkSession::SessionAbortedError
[static,const]	QNetworkSession_SessionError	UnknownSessionError		Enum constant QNetworkSession::UnknownSessionError
	QMetaObject	staticMetaObject		Obtains the static MetaObject for this class.
	string	tr	(string s, string c = nullptr, int n = -1)	Static method QString QNetworkSession::tr(const char s, const char c, int n)
	string	trUtf8	(string s, string c = nullptr, int n = -1)	Static method QString QNetworkSession::trUtf8(const char s, const char c, int n)

Protected methods (static, non-static and constructors)

	void	childEvent	(QChildEvent ptr event)	Virtual method void QNetworkSession::childEvent(QChildEvent *event)
	void	customEvent	(QEvent ptr event)	Virtual method void QNetworkSession::customEvent(QEvent *event)
	void	disconnectNotify	(const QMetaMethod signal)	Virtual method void QNetworkSession::disconnectNotify(const QMetaMethod &signal)
[const]	bool	isSignalConnected	(const QMetaMethod signal)	Method bool QNetworkSession::isSignalConnected(const QMetaMethod &signal)
[const]	int	receivers	(string signal)	Method int QNetworkSession::receivers(const char *signal)
[const]	QObject ptr	sender		Method QObject *QNetworkSession::sender()
[const]	int	senderSignalIndex		Method int QNetworkSession::senderSignalIndex()
	void	timerEvent	(QTimerEvent ptr event)	Virtual method void QNetworkSession::timerEvent(QTimerEvent *event)

Detailed description

Closing	Signature: [static,const] QNetworkSession_State Closing Description: Enum constant QNetworkSession::Closing Python specific notes: The object exposes a readable attribute 'Closing'. This is the getter.
Connected	Signature: [static,const] QNetworkSession_State Connected Description: Enum constant QNetworkSession::Connected Python specific notes: The object exposes a readable attribute 'Connected'. This is the getter.
Connecting	Signature: [static,const] QNetworkSession_State Connecting Description: Enum constant QNetworkSession::Connecting Python specific notes: The object exposes a readable attribute 'Connecting'. This is the getter.
Disconnected	Signature: [static,const] QNetworkSession_State Disconnected Description: Enum constant QNetworkSession::Disconnected Python specific notes: The object exposes a readable attribute 'Disconnected'. This is the getter.
Invalid	Signature: [static,const] QNetworkSession_State Invalid Description: Enum constant QNetworkSession::Invalid Python specific notes: The object exposes a readable attribute 'Invalid'. This is the getter.
InvalidConfigurationError	Signature: [static,const] QNetworkSession_SessionError InvalidConfigurationError Description: Enum constant QNetworkSession::InvalidConfigurationError Python specific notes: The object exposes a readable attribute 'InvalidConfigurationError'. This is the getter.
NoBackgroundTrafficPolicy	Signature: [static,const] QNetworkSession_UsagePolicy NoBackgroundTrafficPolicy Description: Enum constant QNetworkSession::NoBackgroundTrafficPolicy Python specific notes: The object exposes a readable attribute 'NoBackgroundTrafficPolicy'. This is the getter.
NoPolicy	Signature: [static,const] QNetworkSession_UsagePolicy NoPolicy Description: Enum constant QNetworkSession::NoPolicy Python specific notes: The object exposes a readable attribute 'NoPolicy'. This is the getter.
NotAvailable	Signature: [static,const] QNetworkSession_State NotAvailable Description: Enum constant QNetworkSession::NotAvailable Python specific notes: The object exposes a readable attribute 'NotAvailable'. This is the getter.
OperationNotSupportedError	Signature: [static,const] QNetworkSession_SessionError OperationNotSupportedError Description: Enum constant QNetworkSession::OperationNotSupportedError Python specific notes: The object exposes a readable attribute 'OperationNotSupportedError'. This is the getter.
Roaming	Signature: [static,const] QNetworkSession_State Roaming Description: Enum constant QNetworkSession::Roaming Python specific notes: The object exposes a readable attribute 'Roaming'. This is the getter.
RoamingError	Signature: [static,const] QNetworkSession_SessionError RoamingError Description: Enum constant QNetworkSession::RoamingError Python specific notes: The object exposes a readable attribute 'RoamingError'. This is the getter.
SessionAbortedError	Signature: [static,const] QNetworkSession_SessionError SessionAbortedError Description: Enum constant QNetworkSession::SessionAbortedError Python specific notes: The object exposes a readable attribute 'SessionAbortedError'. This is the getter.
UnknownSessionError	Signature: [static,const] QNetworkSession_SessionError UnknownSessionError Description: Enum constant QNetworkSession::UnknownSessionError Python specific notes: The object exposes a readable attribute 'UnknownSessionError'. This is the getter.
_create	Signature: void _create Description: Ensures the C++ object is created Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.
_destroy	Signature: void _destroy Description: Explicitly destroys the object Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.
_destroyed?	Signature: [const] bool _destroyed? Description: Returns a value indicating whether the object was already destroyed This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.
_is_const_object?	Signature: [const] bool _is_const_object? Description: Returns a value indicating whether the reference is a const reference This method returns true, if self is a const reference. In that case, only const methods may be called on self.
_manage	Signature: void _manage Description: Marks the object as managed by the script side. After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required. Usually it's not required to call this method. It has been introduced in version 0.24.
_unmanage	Signature: void _unmanage Description: Marks the object as no longer owned by the script side. Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur. Usually it's not required to call this method. It has been introduced in version 0.24.
accept	Signature: void accept Description: Method void QNetworkSession::accept()
activeTime	Signature: [const] unsigned long long activeTime Description: Method quint64 QNetworkSession::activeTime()
bytesReceived	Signature: [const] unsigned long long bytesReceived Description: Method quint64 QNetworkSession::bytesReceived()
bytesWritten	Signature: [const] unsigned long long bytesWritten Description: Method quint64 QNetworkSession::bytesWritten()
childEvent	Signature: void childEvent (QChildEvent ptr event) Description: Virtual method void QNetworkSession::childEvent(QChildEvent *event) This method can be reimplemented in a derived class.
close	Signature: void close Description: Method void QNetworkSession::close()
closed	Signature: [signal] void closed Description: Signal declaration for QNetworkSession::closed() You can bind a procedure to this signal. Python specific notes: The object exposes a readable attribute 'closed'. This is the getter. The object exposes a writable attribute 'closed'. This is the setter.
configuration	Signature: [const] QNetworkConfiguration configuration Description: Method QNetworkConfiguration QNetworkSession::configuration()
customEvent	Signature: void customEvent (QEvent ptr event) Description: Virtual method void QNetworkSession::customEvent(QEvent *event) This method can be reimplemented in a derived class.
destroyed	Signature: [signal] void destroyed (QObject ptr arg1) Description: Signal declaration for QNetworkSession::destroyed(QObject ) You can bind a procedure to this signal. Python specific notes:* The object exposes a readable attribute 'destroyed'. This is the getter. The object exposes a writable attribute 'destroyed'. This is the setter.
disconnectNotify	Signature: void disconnectNotify (const QMetaMethod signal) Description: Virtual method void QNetworkSession::disconnectNotify(const QMetaMethod &signal) This method can be reimplemented in a derived class.
emit_closed	Signature: void emit_closed Description: Emitter for signal void QNetworkSession::closed() Call this method to emit this signal.
emit_destroyed	Signature: void emit_destroyed (QObject ptr arg1 = nullptr) Description: Emitter for signal void QNetworkSession::destroyed(QObject *) Call this method to emit this signal.
emit_error_sig	Signature: void emit_error_sig (const QNetworkSession_SessionError arg1) Description: Emitter for signal void QNetworkSession::error(QNetworkSession::SessionError) Call this method to emit this signal.
emit_newConfigurationActivated	Signature: void emit_newConfigurationActivated Description: Emitter for signal void QNetworkSession::newConfigurationActivated() Call this method to emit this signal.
emit_objectNameChanged	Signature: void emit_objectNameChanged (string objectName) Description: Emitter for signal void QNetworkSession::objectNameChanged(const QString &objectName) Call this method to emit this signal.
emit_opened	Signature: void emit_opened Description: Emitter for signal void QNetworkSession::opened() Call this method to emit this signal.
emit_preferredConfigurationChanged	Signature: void emit_preferredConfigurationChanged (const QNetworkConfiguration config, bool isSeamless) Description: Emitter for signal void QNetworkSession::preferredConfigurationChanged(const QNetworkConfiguration &config, bool isSeamless) Call this method to emit this signal.
emit_stateChanged	Signature: void emit_stateChanged (const QNetworkSession_State arg1) Description: Emitter for signal void QNetworkSession::stateChanged(QNetworkSession::State) Call this method to emit this signal.
emit_usagePoliciesChanged	Signature: void emit_usagePoliciesChanged (QNetworkSession_QFlags_UsagePolicy usagePolicies) Description: Emitter for signal void QNetworkSession::usagePoliciesChanged(QFlags<QNetworkSession::UsagePolicy> usagePolicies) Call this method to emit this signal.
error	Signature: [const] QNetworkSession_SessionError error Description: Method QNetworkSession::SessionError QNetworkSession::error()
errorString	Signature: [const] string errorString Description: Method QString QNetworkSession::errorString()
error_sig	Signature: [signal] void error_sig (const QNetworkSession_SessionError arg1) Description: Signal declaration for QNetworkSession::error(QNetworkSession::SessionError) You can bind a procedure to this signal. Python specific notes: The object exposes a readable attribute 'error_sig'. This is the getter. The object exposes a writable attribute 'error_sig'. This is the setter.
event	Signature: bool event (QEvent ptr event) Description: Virtual method bool QNetworkSession::event(QEvent *event) This method can be reimplemented in a derived class.
eventFilter	Signature: bool eventFilter (QObject ptr watched, QEvent ptr event) Description: Virtual method bool QNetworkSession::eventFilter(QObject watched, QEvent event) This method can be reimplemented in a derived class.
ignore	Signature: void ignore Description: Method void QNetworkSession::ignore()
interface	Signature: [const] QNetworkInterface interface Description: Method QNetworkInterface QNetworkSession::interface()
isOpen?	Signature: [const] bool isOpen? Description: Method bool QNetworkSession::isOpen()
isSignalConnected	Signature: [const] bool isSignalConnected (const QMetaMethod signal) Description: Method bool QNetworkSession::isSignalConnected(const QMetaMethod &signal) This method is protected and can only be called from inside a derived class.
migrate	Signature: void migrate Description: Method void QNetworkSession::migrate()
new	Signature: [static] new QNetworkSession new (const QNetworkConfiguration connConfig, QObject ptr parent = nullptr) Description: Constructor QNetworkSession::QNetworkSession(const QNetworkConfiguration &connConfig, QObject parent) This method creates an object of class QNetworkSession. Python specific notes:* This method is the default initializer of the object.
newConfigurationActivated	Signature: [signal] void newConfigurationActivated Description: Signal declaration for QNetworkSession::newConfigurationActivated() You can bind a procedure to this signal. Python specific notes: The object exposes a readable attribute 'newConfigurationActivated'. This is the getter. The object exposes a writable attribute 'newConfigurationActivated'. This is the setter.
objectNameChanged	Signature: [signal] void objectNameChanged (string objectName) Description: Signal declaration for QNetworkSession::objectNameChanged(const QString &objectName) You can bind a procedure to this signal. Python specific notes: The object exposes a readable attribute 'objectNameChanged'. This is the getter. The object exposes a writable attribute 'objectNameChanged'. This is the setter.
open	Signature: void open Description: Method void QNetworkSession::open()
opened	Signature: [signal] void opened Description: Signal declaration for QNetworkSession::opened() You can bind a procedure to this signal. Python specific notes: The object exposes a readable attribute 'opened'. This is the getter. The object exposes a writable attribute 'opened'. This is the setter.
preferredConfigurationChanged	Signature: [signal] void preferredConfigurationChanged (const QNetworkConfiguration config, bool isSeamless) Description: Signal declaration for QNetworkSession::preferredConfigurationChanged(const QNetworkConfiguration &config, bool isSeamless) You can bind a procedure to this signal. Python specific notes: The object exposes a readable attribute 'preferredConfigurationChanged'. This is the getter. The object exposes a writable attribute 'preferredConfigurationChanged'. This is the setter.
receivers	Signature: [const] int receivers (string signal) Description: Method int QNetworkSession::receivers(const char *signal) This method is protected and can only be called from inside a derived class.
reject	Signature: void reject Description: Method void QNetworkSession::reject()
sender	Signature: [const] QObject ptr sender Description: Method QObject *QNetworkSession::sender() This method is protected and can only be called from inside a derived class.
senderSignalIndex	Signature: [const] int senderSignalIndex Description: Method int QNetworkSession::senderSignalIndex() This method is protected and can only be called from inside a derived class.
sessionProperty	Signature: [const] variant sessionProperty (string key) Description: Method QVariant QNetworkSession::sessionProperty(const QString &key)
setSessionProperty	Signature: void setSessionProperty (string key, variant value) Description: Method void QNetworkSession::setSessionProperty(const QString &key, const QVariant &value)
state	Signature: [const] QNetworkSession_State state Description: Method QNetworkSession::State QNetworkSession::state()
stateChanged	Signature: [signal] void stateChanged (const QNetworkSession_State arg1) Description: Signal declaration for QNetworkSession::stateChanged(QNetworkSession::State) You can bind a procedure to this signal. Python specific notes: The object exposes a readable attribute 'stateChanged'. This is the getter. The object exposes a writable attribute 'stateChanged'. This is the setter.
staticMetaObject	Signature: [static] QMetaObject staticMetaObject Description: Obtains the static MetaObject for this class.
stop	Signature: void stop Description: Method void QNetworkSession::stop()
timerEvent	Signature: void timerEvent (QTimerEvent ptr event) Description: Virtual method void QNetworkSession::timerEvent(QTimerEvent *event) This method can be reimplemented in a derived class.
tr	Signature: [static] string tr (string s, string c = nullptr, int n = -1) Description: Static method QString QNetworkSession::tr(const char s, const char c, int n) This method is static and can be called without an instance.
trUtf8	Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1) Description: Static method QString QNetworkSession::trUtf8(const char s, const char c, int n) This method is static and can be called without an instance.
usagePolicies	Signature: [const] QNetworkSession_QFlags_UsagePolicy usagePolicies Description: Method QFlags<QNetworkSession::UsagePolicy> QNetworkSession::usagePolicies()
usagePoliciesChanged	Signature: [signal] void usagePoliciesChanged (QNetworkSession_QFlags_UsagePolicy usagePolicies) Description: Signal declaration for QNetworkSession::usagePoliciesChanged(QFlags<QNetworkSession::UsagePolicy> usagePolicies) You can bind a procedure to this signal. Python specific notes: The object exposes a readable attribute 'usagePoliciesChanged'. This is the getter. The object exposes a writable attribute 'usagePoliciesChanged'. This is the setter.
waitForOpened	Signature: bool waitForOpened (int msecs = 30000) Description: Method bool QNetworkSession::waitForOpened(int msecs)

API reference - Class QNetworkSession

Public constructors

Public methods

Public static methods and constants

Protected methods (static, non-static and constructors)

Detailed description

Closing

Connected

Connecting

Disconnected

Invalid

InvalidConfigurationError

NoBackgroundTrafficPolicy

NoPolicy

NotAvailable

OperationNotSupportedError

Roaming

RoamingError

SessionAbortedError

UnknownSessionError

_create

_destroy

_destroyed?

_is_const_object?

_manage

_unmanage

accept

activeTime

bytesReceived

bytesWritten

childEvent

close

closed

configuration

customEvent

destroyed

disconnectNotify

emit_closed

emit_destroyed

emit_error_sig

emit_newConfigurationActivated

emit_objectNameChanged

emit_opened

emit_preferredConfigurationChanged

emit_stateChanged

emit_usagePoliciesChanged

error

errorString

error_sig

event

eventFilter

ignore

interface

isOpen?

isSignalConnected

migrate

new

newConfigurationActivated

objectNameChanged

open

opened

preferredConfigurationChanged

receivers

reject

sender

senderSignalIndex

sessionProperty

setSessionProperty

state

stateChanged

staticMetaObject

stop

timerEvent

tr

trUtf8

usagePolicies

usagePoliciesChanged

waitForOpened