Snakepit.Bridge.Session (Snakepit v0.6.10)

@type t() :: %Snakepit.Bridge.Session{
  created_at: integer(),
  id: String.t(),
  last_accessed: integer(),
  last_worker_id: String.t() | nil,
  metadata: map(),
  programs: map(),
  stats: map(),
  ttl: integer()
}

Functions

delete_program(session, program_id)

@spec delete_program(t(), String.t()) :: t()

Removes a program from the session.

Parameters

session - The session to update
program_id - The program identifier to remove

Returns

Updated session with the program removed.

expired?(session, current_time \\ nil)

@spec expired?(t(), integer() | nil) :: boolean()

Checks if a session has expired based on its TTL.

Parameters

session - The session to check
current_time - Optional current time (defaults to current monotonic time)

Returns

true if the session has expired, false otherwise.

get_metadata(session, key, default \\ nil)

@spec get_metadata(t(), term(), term()) :: term()

Gets metadata from the session.

Parameters

session - The session to query
key - The metadata key
default - Default value if key not found

Returns

The metadata value or the default.

get_program(session, program_id)

@spec get_program(t(), String.t()) :: {:ok, term()} | {:error, :not_found}

Gets a program from the session.

Parameters

session - The session to query
program_id - The program identifier

Returns

{:ok, program_data} if found, {:error, :not_found} if not found.

get_stats(session)

@spec get_stats(t()) :: map()

Gets session statistics.

new(id, opts \\ [])

@spec new(
  String.t(),
  keyword()
) :: t()

Creates a new session with the given ID and options.

put_metadata(session, key, value)

@spec put_metadata(t(), term(), term()) :: t()

Updates session metadata.

Parameters

session - The session to update
key - The metadata key
value - The metadata value

Returns

Updated session with the metadata updated.

put_program(session, program_id, program_data)

@spec put_program(t(), String.t(), term()) :: t()

Adds or updates a program in the session.

Parameters

session - The session to update
program_id - The program identifier
program_data - The program data to store

Returns

Updated session with the program added/updated.

touch(session)

@spec touch(t()) :: t()

Updates the last_accessed timestamp to the current time.

Parameters

session - The session to touch

Returns

Updated session with current last_accessed timestamp.

validate(session)

@spec validate(t()) :: :ok | {:error, term()}

Validates that a session struct has all required fields and valid data.

Parameters

session - The session to validate

Returns

:ok if valid, {:error, reason} if invalid.