Class: GrpcDelegateStream
nekte-protocol / server/src / GrpcDelegateStream
Class: GrpcDelegateStream
Defined in: nekte-source/packages/server/src/grpc-stream.ts:22
Constructors
Constructor
new GrpcDelegateStream(
stream):GrpcDelegateStream
Defined in: nekte-source/packages/server/src/grpc-stream.ts:26
Parameters
stream
Returns
GrpcDelegateStream
Accessors
isClosed
Get Signature
get isClosed():
boolean
Defined in: nekte-source/packages/server/src/grpc-stream.ts:116
Whether the stream has been closed
Returns
boolean
Methods
cancelled()
cancelled(
taskId,previousStatus,reason?):void
Defined in: nekte-source/packages/server/src/grpc-stream.ts:69
Send a cancelled event
Parameters
taskId
string
previousStatus
TaskStatus
reason?
string
Returns
void
close()
close():
void
Defined in: nekte-source/packages/server/src/grpc-stream.ts:109
Close the gRPC stream
Returns
void
complete()
complete(
taskId,out,meta?):void
Defined in: nekte-source/packages/server/src/grpc-stream.ts:47
Send completion event and close the stream
Parameters
taskId
string
out
MultiLevelResult
meta?
ms?
number
tokens_used?
number
Returns
void
error()
error(
code,message,taskId?):void
Defined in: nekte-source/packages/server/src/grpc-stream.ts:60
Send error event and close the stream
Parameters
code
number
message
string
taskId?
string
Returns
void
partial()
partial(
out,resolvedLevel?):void
Defined in: nekte-source/packages/server/src/grpc-stream.ts:39
Send a partial result
Parameters
out
Record<string, unknown>
resolvedLevel?
any
Returns
void
progress()
progress(
processed,total,message?):void
Defined in: nekte-source/packages/server/src/grpc-stream.ts:31
Send a progress event
Parameters
processed
number
total
number
message?
string
Returns
void
resumed()
resumed(
taskId,fromCheckpoint):void
Defined in: nekte-source/packages/server/src/grpc-stream.ts:86
Send a resumed event
Parameters
taskId
string
fromCheckpoint
boolean
Returns
void
send()
send(
event):void
Defined in: nekte-source/packages/server/src/grpc-stream.ts:102
Send a raw SSE event (converted to proto)
Parameters
event
SseEvent
Returns
void
statusChange()
statusChange(
taskId,from,to,reason?):void
Defined in: nekte-source/packages/server/src/grpc-stream.ts:94
Send a status change event
Parameters
taskId
string
from
TaskStatus
to
TaskStatus
reason?
string
Returns
void
suspended()
suspended(
taskId,checkpointAvailable):void
Defined in: nekte-source/packages/server/src/grpc-stream.ts:78
Send a suspended event
Parameters
taskId
string
checkpointAvailable
boolean
Returns
void