394 lines
No EOL
11 KiB
HTML
394 lines
No EOL
11 KiB
HTML
<!-- title: frappe.async --><div class="dev-header">
|
|
|
|
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
|
|
Version 6.6.5</a>
|
|
|
|
|
|
<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/async.py"
|
|
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 style="font-weight: normal;">Class <b>FileAndRedisStream</b></h3>
|
|
|
|
<p style="padding-left: 30px;"><i>Inherits from __builtin__.file</i></h4>
|
|
|
|
<div class="docs-attr-desc"><p></p>
|
|
</div>
|
|
<div style="padding-left: 30px;">
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="__init__" href="#__init__" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>__init__</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="write" href="#write" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>write</b>
|
|
<i class="text-muted">(self, data)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
</div>
|
|
<hr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p><span class="label label-info">Public API</span>
|
|
<br><code>/api/method/frappe.async.can_subscribe_doc</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.async.can_subscribe_doc" href="#frappe.async.can_subscribe_doc" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.async.<b>can_subscribe_doc</b>
|
|
<i class="text-muted">(doctype, docname, sid)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.async.emit_via_redis" href="#frappe.async.emit_via_redis" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.async.<b>emit_via_redis</b>
|
|
<i class="text-muted">(event, message, room)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Publish real-time updates via redis</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>event</code></strong> - Event name, like <code>task_progress</code> etc.</li>
|
|
<li><strong><code>message</code></strong> - JSON message object. For async must contain <code>task_id</code></li>
|
|
<li><strong><code>room</code></strong> - name of the room</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.async.get_doc_room" href="#frappe.async.get_doc_room" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.async.<b>get_doc_room</b>
|
|
<i class="text-muted">(doctype, docname)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p><span class="label label-info">Public API</span>
|
|
<br><code>/api/method/frappe.async.get_pending_tasks_for_doc</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.async.get_pending_tasks_for_doc" href="#frappe.async.get_pending_tasks_for_doc" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.async.<b>get_pending_tasks_for_doc</b>
|
|
<i class="text-muted">(doctype, docname)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.async.get_redis_server" href="#frappe.async.get_redis_server" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.async.<b>get_redis_server</b>
|
|
<i class="text-muted">()</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Returns memcache connection.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.async.get_site_room" href="#frappe.async.get_site_room" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.async.<b>get_site_room</b>
|
|
<i class="text-muted">()</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.async.get_std_streams" href="#frappe.async.get_std_streams" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.async.<b>get_std_streams</b>
|
|
<i class="text-muted">(task_id)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.async.get_task_log_file_path" href="#frappe.async.get_task_log_file_path" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.async.<b>get_task_log_file_path</b>
|
|
<i class="text-muted">(task_id, stream_type)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.async.get_task_progress_room" href="#frappe.async.get_task_progress_room" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.async.<b>get_task_progress_room</b>
|
|
<i class="text-muted">()</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p><span class="label label-info">Public API</span>
|
|
<br><code>/api/method/frappe.async.get_task_status</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.async.get_task_status" href="#frappe.async.get_task_status" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.async.<b>get_task_status</b>
|
|
<i class="text-muted">(task_id)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p><span class="label label-info">Public API</span>
|
|
<br><code>/api/method/frappe.async.get_user_info</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.async.get_user_info" href="#frappe.async.get_user_info" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.async.<b>get_user_info</b>
|
|
<i class="text-muted">(sid)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.async.get_user_room" href="#frappe.async.get_user_room" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.async.<b>get_user_room</b>
|
|
<i class="text-muted">(user)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.async.handler" href="#frappe.async.handler" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.async.<b>handler</b>
|
|
<i class="text-muted">(f)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.async.is_file_old" href="#frappe.async.is_file_old" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.async.<b>is_file_old</b>
|
|
<i class="text-muted">(file_path)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p><span class="label label-info">Public API</span>
|
|
<br><code>/api/method/frappe.async.ping</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.async.ping" href="#frappe.async.ping" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.async.<b>ping</b>
|
|
<i class="text-muted">()</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.async.publish_realtime" href="#frappe.async.publish_realtime" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.async.<b>publish_realtime</b>
|
|
<i class="text-muted">(event=None, message=None, room=None, user=None, doctype=None, docname=None, now=False)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Publish real-time updates</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>event</code></strong> - Event name, like <code>task_progress</code> etc. that will be handled by the client (default is <code>task_progress</code> if within task or <code>global</code>)</li>
|
|
<li><strong><code>message</code></strong> - JSON message object. For async must contain <code>task_id</code></li>
|
|
<li><strong><code>room</code></strong> - Room in which to publish update (default entire site)</li>
|
|
<li><strong><code>user</code></strong> - Transmit to user</li>
|
|
<li><strong><code>doctype</code></strong> - Transmit to doctype, docname</li>
|
|
<li><strong><code>docname</code></strong> - Transmit to doctype, docname</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.async.put_log" href="#frappe.async.put_log" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.async.<b>put_log</b>
|
|
<i class="text-muted">(line_no, line, task_id=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.async.remove_old_task_logs" href="#frappe.async.remove_old_task_logs" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.async.<b>remove_old_task_logs</b>
|
|
<i class="text-muted">()</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.async.set_task_status" href="#frappe.async.set_task_status" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.async.<b>set_task_status</b>
|
|
<i class="text-muted">(task_id, status, response=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<!-- autodoc --> |