Inherits from __builtin__.file
Public API
/api/method/frappe.async.can_subscribe_doc
frappe.async.can_subscribe_doc (doctype, docname, sid)
No docs
frappe.async.emit_via_redis (event, message, room)
Publish real-time updates via redis
Parameters:
event
- Event name, like task_progress
etc.message
- JSON message object. For async must contain task_id
room
- name of the roomfrappe.async.get_doc_room (doctype, docname)
No docs
Public API
/api/method/frappe.async.get_pending_tasks_for_doc
frappe.async.get_pending_tasks_for_doc (doctype, docname)
No docs
frappe.async.get_redis_server ()
Returns memcache connection.
No docs
frappe.async.get_std_streams (task_id)
No docs
frappe.async.get_task_log_file_path (task_id, stream_type)
No docs
frappe.async.get_task_progress_room ()
No docs
Public API
/api/method/frappe.async.get_task_status
frappe.async.get_task_status (task_id)
No docs
Public API
/api/method/frappe.async.get_user_info
frappe.async.get_user_info (sid)
No docs
frappe.async.get_user_room (user)
No docs
No docs
frappe.async.is_file_old (file_path)
No docs
Public API
/api/method/frappe.async.ping
No docs
frappe.async.publish_realtime (event=None, message=None, room=None, user=None, doctype=None, docname=None, after_commit=False)
Publish real-time updates
Parameters:
event
- Event name, like task_progress
etc. that will be handled by the client (default is task_progress
if within task or global
)message
- JSON message object. For async must contain task_id
room
- Room in which to publish update (default entire site)user
- Transmit to userdoctype
- Transmit to doctype, docnamedocname
- Transmit to doctype, docnameafter_commit
- (default False) will emit after current transaction is committedfrappe.async.put_log (line_no, line, task_id=None)
No docs
frappe.async.remove_old_task_logs ()
No docs
frappe.async.set_task_status (task_id, status, response=None)
No docs