4.5. umbra.components.addons.tcpServerUi.tcpServerUi
tcpServerUi.py
- Platform:
- Windows, Linux, Mac Os X.
- Description:
- Defines the TCPServerUi Component Interface class and others helper objects.
Others:
4.5.1. Module Attributes
-
umbra.components.addons.tcpServerUi.tcpServerUi.LOGGER
-
umbra.components.addons.tcpServerUi.tcpServerUi.COMPONENT_UI_FILE
4.5.2. Classes
-
class umbra.components.addons.tcpServerUi.tcpServerUi.RequestsStackDataHandler(request, client_address, server)[source]
Bases: SocketServer.BaseRequestHandler
Defines the default requests handler.
-
handle()[source]
Reimplements the SocketServer.BaseRequestHandler.handle() method.
| Returns: | Method success. |
|---|
| Return type: | bool |
|---|
-
class umbra.components.addons.tcpServerUi.tcpServerUi.TCPServerUi(parent=None, name=None, *args, **kwargs)[source]
Bases: manager.qwidgetComponent.QWidgetComponent
Defines the umbra.components.factory.tcpServerUi.tcpServerUi Component Interface class.
It provides various methods to operate the TCP Server.
Initializes the class.
| Parameters: |
- parent (QObject) – Object parent.
- name (unicode) – Component name.
- *args (*) – Arguments.
- **kwargs (**) – Keywords arguments.
|
|---|
-
engine[source]
Property for self.__engine attribute.
| Returns: | self.__engine. |
|---|
| Return type: | QObject |
|---|
-
settings[source]
Property for self.__settings attribute.
| Returns: | self.__settings. |
|---|
| Return type: | QSettings |
|---|
-
settingsSection[source]
Property for self.__settingsSection attribute.
| Returns: | self.__settingsSection. |
|---|
| Return type: | unicode |
|---|
-
preferencesManager[source]
Property for self.__preferencesManager attribute.
| Returns: | self.__preferencesManager. |
|---|
| Return type: | QWidget |
|---|
-
tcpServer[source]
Property for self.__tcpServer attribute.
| Returns: | self.__tcpServer. |
|---|
| Return type: | QWidget |
|---|
-
address[source]
Property for self.__address attribute.
| Returns: | self.__address. |
|---|
| Return type: | unicode |
|---|
-
port[source]
Property for self.__port attribute.
| Returns: | self.__port. |
|---|
| Return type: | int |
|---|
-
activate(engine)[source]
Activates the Component.
| Parameters: | engine (QObject) – Engine to attach the Component to. |
|---|
| Returns: | Method success. |
|---|
| Return type: | bool |
|---|
-
deactivate()[source]
Deactivates the Component.
| Returns: | Method success. |
|---|
| Return type: | bool |
|---|
-
initializeUi()[source]
Initializes the Component ui.
| Returns: | Method success. |
|---|
| Return type: | bool |
|---|
-
uninitializeUi()[source]
Uninitializes the Component ui.
| Returns: | Method success. |
|---|
| Return type: | bool |
|---|
-
addWidget()[source]
Adds the Component Widget to the engine.
| Returns: | Method success. |
|---|
| Return type: | bool |
|---|
-
removeWidget()[source]
Removes the Component Widget from the engine.
| Returns: | Method success. |
|---|
| Return type: | bool |
|---|
-
onStartup()[source]
Defines the slot triggered on Framework startup.
-
onClose()[source]
Defines the slot triggered on Framework close.
-
startTcpServer(port)[source]
Starts the TCP server using given port.
| Parameters: | port (int) – Port. |
|---|
| Returns: | Method success. |
|---|
| Return type: | bool |
|---|
-
stopTcpServer()[source]
Stops the TCP server.
| Returns: | Method success. |
|---|
| Return type: | bool |
|---|