Contents

# This event signals that some state in the debug adapter has changed and requires
# that the client needs to re-render the data snapshot previously requested. Debug
# adapters do not have to emit this event for runtime changes like stopped or
# thread events because in that case the client refetches the new state anyway.
# But the event can be used for example to refresh the UI after rendering
# formatting has changed in the debug adapter. This event should only be sent if
# the debug adapter has received a value true for the ‘supportsInvalidatedEvent’
# capability of the ‘initialize’ request.
class DAP::InvalidatedEventBody < DAP::Base
  # Optional set of logical areas that got invalidated. This property has a hint characteristic: a client can only be expected to make a 'best effort' in honouring the areas but there are no guarantees. If this property is missing, empty, or if values are not understand the client should assume a single value 'all'.
  property :areas, required: false, as: 'InvalidatedAreas[]'

  # If specified, the client only needs to refetch data related to this thread.
  property :threadId, required: false, as: 'number'

  # If specified, the client only needs to refetch data related to this stack frame (and the 'threadId' is ignored).
  property :stackFrameId, required: false, as: 'number'
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
ruby-dap-0.1.3	lib/dap/invalidated_event_body.rb