quickshell-web/modules/Quickshell.Io/Socket.json
2024-09-28 02:35:19 +03:00

80 lines
2 KiB
JSON

{
"name": "Socket",
"module": "Quickshell.Io",
"type": "class",
"super": {
"type": "local",
"module": "Quickshell.Io",
"name": "DataStream"
},
"description": "Unix socket listener.",
"details": "",
"properties": {
"path": {
"type": {
"type": "qt",
"module": "qml",
"name": "string"
},
"details": "The path to connect this socket to when TYPE99Vconnected99Tprop99TYPE is set to true.\n\nChanging this property will have no effect while the connection is active.\n"
},
"connected": {
"type": {
"type": "qt",
"module": "qml",
"name": "bool"
},
"details": "Returns if the socket is currently connected.\n\nWriting to this property will set the target connection state and will not\nupdate the property immediately. Setting the property to false will begin disconnecting\nthe socket, and setting it to true will begin connecting the socket if path is not empty.\n"
}
},
"functions": [
{
"ret": {
"type": "qt",
"module": "qml",
"name": "void"
},
"name": "flush",
"id": "flush",
"details": "Flush any queued writes to the socket.\n",
"params": []
},
{
"ret": {
"type": "qt",
"module": "qml",
"name": "void"
},
"name": "write",
"id": "write",
"details": "Write data to the socket. Does nothing if not connected.\n\nRemember to call flush after your last write.\n",
"params": [
{
"name": "data",
"type": {
"type": "qt",
"module": "qml",
"name": "string"
}
}
]
}
],
"signals": {
"error": {
"name": "error",
"details": "This signal is sent whenever a socket error is encountered.\n",
"params": [
{
"name": "error",
"type": {
"type": "unknown",
"module": "",
"name": ""
}
}
]
}
},
"variants": {}
}