rpc_server
AyonLocalHost
Bases: Route
Handle Menu calls from JS part of ComfyUI plugin.
Source code in client/ayon_comfyui/api/rpc_server.py
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 | |
init(**kwargs)
Override of init method. Can return anything.
Source code in client/ayon_comfyui/api/rpc_server.py
130 131 132 | |
pingAyonMenu(message) async
Returns message sent from server.
Source code in client/ayon_comfyui/api/rpc_server.py
138 139 140 141 | |
requestSaveByName(file_name, workfile_contents) async
Schedule saving workfile in thread.
File name is without extension (as represented in ComfyUI tab)
Source code in client/ayon_comfyui/api/rpc_server.py
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 | |
requestToolByName(tool_name) async
Schedule tool in thread.
Source code in client/ayon_comfyui/api/rpc_server.py
143 144 145 146 147 148 149 150 | |
RPCServerThread
Bases: Thread
Manages event loop for the server that recieves messages.
In particular, deal with the JavaScript part of the plugin.
Source code in client/ayon_comfyui/api/rpc_server.py
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 | |
is_set_up property
Return whether the server is set up.
This doesn't mean that the server is running, but it means that the server is ready to run.
loop property
Return contained loop.
async_run() async
Run server async.
Source code in client/ayon_comfyui/api/rpc_server.py
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 | |
check_any_origin_client() async
If shutdown flag isn't set, check for valid frontend conns.
Source code in client/ayon_comfyui/api/rpc_server.py
249 250 251 252 253 254 255 256 257 258 | |
flag_valid_client()
Notify server a verified origin client connection has been made.
Source code in client/ayon_comfyui/api/rpc_server.py
260 261 262 | |
get_thread() classmethod
Return stored thread.
Source code in client/ayon_comfyui/api/rpc_server.py
202 203 204 205 | |
run()
Do server run.
Source code in client/ayon_comfyui/api/rpc_server.py
215 216 217 218 219 220 221 222 | |
setup_server()
Set up server, do not start it yet.
Source code in client/ayon_comfyui/api/rpc_server.py
207 208 209 210 211 212 213 | |
stop()
Stop server from running.
Source code in client/ayon_comfyui/api/rpc_server.py
278 279 280 | |
call_on_origin(origin=None, namespace=None, *, wait_forever=False)
Decorator to send a function to a specific client on websocket thread.
Function signature should be like this:
@call_on_origin(
origin = "http://expected-origin.com",
namespace = "namespace"
)
def name_of_method(*, arg1='default1', arg2='default2') -> T:
pass
And will result in a:
future = asyncio.run_coroutine_threadsafe(
found_client_for_origin.call(namespace.name_of_method)
)
return future.result()
Source code in client/ayon_comfyui/api/rpc_server.py
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 | |
get_client_from_origin(origin)
Attempt to get client from socket connections.
This mimics the photoshop ayon plugin, where the socket is read out and the first connection is picked. We want to be more thorough though, and make sure the connection header checks out!
Returns:
| Type | Description |
|---|---|
WSRPCBase | None | None if not found else WSRPCBase |
Source code in client/ayon_comfyui/api/rpc_server.py
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 | |
overwrite_workfile(workfile_name, workfile_contents)
Overwrite workfile if it exists.
Show workfiles menu if no path was matched.
Source code in client/ayon_comfyui/api/rpc_server.py
80 81 82 83 84 85 86 87 88 89 90 | |
pull_origin_from_settings()
Return expected RPC origin adress from settings.
Source code in client/ayon_comfyui/api/rpc_server.py
93 94 95 96 97 98 99 100 | |
show_tool_by_name(tool_name)
Show host tool by name, with default settings.
Source code in client/ayon_comfyui/api/rpc_server.py
30 31 32 33 34 35 36 37 38 39 40 41 42 43 | |