Class SessionContext

constructor

• new SessionContext(options: SessionContext.IOptions): SessionContext

• Construct a new session context.

  Parameters

  • options: SessionContext.IOptions

  Returns SessionContext

Optional ReadonlykernelManager

ReadonlysessionManager

ReadonlyspecsManager

connectionStatusChanged

• get connectionStatusChanged(): ISignal<this, Kernel.ConnectionStatus>

• A signal emitted when the kernel status changes, proxied from the kernel.

  Returns ISignal<this, Kernel.ConnectionStatus>

disposed

• get disposed(): ISignal<this, void>

• A signal emitted when the poll is disposed.

  Returns ISignal<this, void>

hasNoKernel

• get hasNoKernel(): boolean

• Whether the kernel is "No Kernel" or not.

  Notes

  As the displayed name is translated, this can be used directly.

  Returns boolean

iopubMessage

• get iopubMessage(): ISignal<this, IIOPubMessage<IOPubMessageType>>

• A signal emitted for iopub kernel messages, proxied from the kernel.

  Returns ISignal<this, IIOPubMessage<IOPubMessageType>>

isDisposed

• get isDisposed(): boolean

• Test whether the context is disposed.

  Returns boolean

isReady

• get isReady(): boolean

• Whether the context is ready.

  Returns boolean

isRestarting

• get isRestarting(): boolean

• Whether the context is restarting.

  Returns boolean

isTerminating

• get isTerminating(): boolean

• Whether the context is terminating.

  Returns boolean

kernelChanged

• get kernelChanged(): ISignal<this, IKernelChangedArgs>

• A signal emitted when the kernel connection changes, proxied from the session connection.

  Returns ISignal<this, IKernelChangedArgs>

kernelDisplayName

• get kernelDisplayName(): string

• The display name of the current kernel, or a sensible alternative.

  Notes

  This is a convenience function to have a consistent sensible name for the kernel.

  Returns string

kernelDisplayStatus

• get kernelDisplayStatus(): KernelDisplayStatus

• A sensible status to display

  Notes

  This combines the status and connection status into a single status for the user.

  Returns KernelDisplayStatus

kernelPreference

• get kernelPreference(): IKernelPreference

• The kernel preference of this client session.

  This is used when selecting a new kernel, and should reflect the sort of kernel the activity prefers.

  Returns IKernelPreference
• set kernelPreference(value: IKernelPreference): void

• The kernel preference for starting new kernels.

  Parameters

  • value: IKernelPreference

  Returns void

kernelPreferenceChanged

• get kernelPreferenceChanged(): ISignal<
      this,
      IChangedArgs<IKernelPreference, IKernelPreference, string>,
  >

• Signal emitted if the kernel preference changes.

  Returns ISignal<this, IChangedArgs<IKernelPreference, IKernelPreference, string>>

name

• get name(): string

• The session name.

  Notes

  Typically .session.name should be used. This attribute is useful if there is no current session.

  Returns string

path

• get path(): string

• The session path.

  Notes

  Typically .session.path should be used. This attribute is useful if there is no current session.

  Returns string

pendingInput

• get pendingInput(): boolean

• A flag indicating if the session has pending input, proxied from the kernel.

  Returns boolean

prevKernelName

• get prevKernelName(): string

• The name of the previously started kernel.

  Returns string

propertyChanged

• get propertyChanged(): ISignal<this, "name" | "type" | "path">

• A signal emitted when a session property changes, proxied from the current session.

  Returns ISignal<this, "name" | "type" | "path">

ready

• get ready(): Promise<void>

• A promise that is fulfilled when the context is ready.

  Returns Promise<void>

session

• get session(): null | Session.ISessionConnection

• The current session connection.

  Returns null | Session.ISessionConnection

sessionChanged

• get sessionChanged(): ISignal<
      this,
      IChangedArgs<
          null
          | Session.ISessionConnection,
          null | Session.ISessionConnection,
          "session",
      >,
  >

• A signal emitted when the session connection changes.

  Returns ISignal<
      this,
      IChangedArgs<
          null
          | Session.ISessionConnection,
          null | Session.ISessionConnection,
          "session",
      >,
  >

statusChanged

• get statusChanged(): ISignal<this, Kernel.Status>

• A signal emitted when the kernel status changes, proxied from the kernel.

  Returns ISignal<this, Kernel.Status>

type

• get type(): string

• The session type.

  Notes

  Typically .session.type should be used. This attribute is useful if there is no current session.

  Returns string

unhandledMessage

• get unhandledMessage(): ISignal<
      this,
      KernelMessage.IMessage<KernelMessage.MessageType>,
  >

• A signal emitted for an unhandled kernel message, proxied from the kernel.

  Returns ISignal<this, KernelMessage.IMessage<KernelMessage.MessageType>>

_initialize

• _initialize(): Promise<boolean>

• Inner initialize function that doesn't handle promises. This makes it easier to consolidate promise handling logic.

  Returns Promise<boolean>

changeKernel

• changeKernel(
      options?: Partial<Kernel.IModel>,
  ): Promise<null | Kernel.IKernelConnection>

• Change the current kernel associated with the session.

  Parameters

  • options: Partial<Kernel.IModel> = {}

  Returns Promise<null | Kernel.IKernelConnection>

dispose

• dispose(): void

• Dispose of the resources held by the context.

  Returns void

initialize

• initialize(): Promise<boolean>

• Initialize the session context

  Returns Promise<boolean>

  A promise that resolves with whether to ask the user to select a kernel.

  Notes

  If a server session exists on the current path, we will connect to it. If preferences include disabling canStart or shouldStart, no server session will be started. If a kernel id is given, we attempt to start a session with that id. If a default kernel is available, we connect to it. Otherwise we ask the user to select a kernel.

restartKernel

• restartKernel(): Promise<void>

• Restart the current Kernel.

  Returns Promise<void>

  A promise that resolves when the kernel is restarted.

shutdown

• shutdown(): Promise<void>

• Kill the kernel and shutdown the session.

  Returns Promise<void>

  A promise that resolves when the session is shut down.

startKernel

• startKernel(): Promise<boolean>

• Starts new Kernel.

  Returns Promise<boolean>

  Whether to ask the user to pick a kernel.