nextpyp.client.gen.SingleParticleSessionRealtimeServiceConnection

class nextpyp.client.gen.SingleParticleSessionRealtimeServiceConnection

Bases: RealtimeServiceConnection

(no description yet)

Permission Needed:

session_listen

Client to Server messages:

• RealTimeC2SListenToSession

• RealTimeC2SSessionSettingsSaved

Server to Client messages:

• RealTimeS2CSessionStatus

• RealTimeS2CSessionSmallData

• RealTimeS2CSessionLargeData

• RealTimeS2CUpdatedParameters

• RealTimeS2CSessionMicrograph

• RealTimeS2CSessionTwoDClasses

• RealTimeS2CSessionExport

• RealTimeS2CSessionFilesystems

• RealTimeS2CSessionTransferInit

• RealTimeS2CSessionTransferWaiting

• RealTimeS2CSessionTransferStarted

• RealTimeS2CSessionTransferProgress

• RealTimeS2CSessionTransferFinished

• RealTimeS2CSessionDaemonSubmitted

• RealTimeS2CSessionDaemonStarted

• RealTimeS2CSessionDaemonFinished

• RealTimeS2CSessionJobSubmitted

• RealTimeS2CSessionJobStarted

• RealTimeS2CSessionJobFinished

Methods

__init__
recv	Receives a message from the website.
send_listen_to_session	Sends a RealTimeC2SListenToSession message
send_session_settings_saved	Sends a RealTimeC2SSessionSettingsSaved message

Details

__init__(websocket)

Parameters:

websocket (WebSocketClientProtocol) –

Return type:

None

async recv()

Receives a message from the website. Could be any one of several different messages.

Return type:

Union[RealTimeS2CSessionStatus, RealTimeS2CSessionSmallData, RealTimeS2CSessionLargeData, RealTimeS2CUpdatedParameters, RealTimeS2CSessionMicrograph, RealTimeS2CSessionTwoDClasses, RealTimeS2CSessionExport, RealTimeS2CSessionFilesystems, RealTimeS2CSessionTransferInit, RealTimeS2CSessionTransferWaiting, RealTimeS2CSessionTransferStarted, RealTimeS2CSessionTransferProgress, RealTimeS2CSessionTransferFinished, RealTimeS2CSessionDaemonSubmitted, RealTimeS2CSessionDaemonStarted, RealTimeS2CSessionDaemonFinished, RealTimeS2CSessionJobSubmitted, RealTimeS2CSessionJobStarted, RealTimeS2CSessionJobFinished]

Examples

Receive a message from this realtime service:

msg = await project.recv()
if type(msg) is RealTimeS2CSessionStatus:
    print(f'received message: {msg}')
elif type(msg) is RealTimeS2CSessionSmallData:
    print(f'received message: {msg}')
elif type(msg) is RealTimeS2CSessionLargeData:
    print(f'received message: {msg}')
elif type(msg) is RealTimeS2CUpdatedParameters:
    print(f'received message: {msg}')
elif type(msg) is RealTimeS2CSessionMicrograph:
    print(f'received message: {msg}')
elif type(msg) is RealTimeS2CSessionTwoDClasses:
    print(f'received message: {msg}')
elif type(msg) is RealTimeS2CSessionExport:
    print(f'received message: {msg}')
elif type(msg) is RealTimeS2CSessionFilesystems:
    print(f'received message: {msg}')
elif type(msg) is RealTimeS2CSessionTransferInit:
    print(f'received message: {msg}')
elif type(msg) is RealTimeS2CSessionTransferWaiting:
    print(f'received message: {msg}')
elif type(msg) is RealTimeS2CSessionTransferStarted:
    print(f'received message: {msg}')
elif type(msg) is RealTimeS2CSessionTransferProgress:
    print(f'received message: {msg}')
elif type(msg) is RealTimeS2CSessionTransferFinished:
    print(f'received message: {msg}')
elif type(msg) is RealTimeS2CSessionDaemonSubmitted:
    print(f'received message: {msg}')
elif type(msg) is RealTimeS2CSessionDaemonStarted:
    print(f'received message: {msg}')
elif type(msg) is RealTimeS2CSessionDaemonFinished:
    print(f'received message: {msg}')
elif type(msg) is RealTimeS2CSessionJobSubmitted:
    print(f'received message: {msg}')
elif type(msg) is RealTimeS2CSessionJobStarted:
    print(f'received message: {msg}')
elif type(msg) is RealTimeS2CSessionJobFinished:
    print(f'received message: {msg}')
else:
    raise Exception(f'received unexpected msg: {msg}')

async send_listen_to_session(msg)

Sends a RealTimeC2SListenToSession message

Return type:

None

Parameters:

msg (RealTimeC2SListenToSession) –

async send_session_settings_saved(msg)

Sends a RealTimeC2SSessionSettingsSaved message

Return type:

None

Parameters:

msg (RealTimeC2SSessionSettingsSaved) –