Sign in Join
FPDoc Onlineexperiment

TCustomSession class

In unit HTTPDefs

Base class for HTTP session management

Declaration

pascal
TCustomSession = class(TComponent)

Inheritance

  1. TCustomSession
  2. TComponent
  3. TPersistent
  4. TObject

Description

TCustomSession provides the foundation for HTTP session management functionality. It handles session initialization, variable management, state tracking, and cleanup operations.

Properties

TimeOutMinutespublicSession timeout period in minutes
SessionIDpublicUnique identifier for the session
SessionCookiepublicName of the cookie used to store session ID
SessionCookiePathpublicPath attribute for the session cookie
VariablespublicAccess to session variables by name
SessionStatepublicCurrent state of the session
SecureSessionpublic
SameSitePolicypublic

Methods

AddToSessionStateprotected
RemoveFromSessionStateprotected
SetSessionCookieprotected
SetSessionCookiePathprotected
IsValidSessionIDprotected
GetSessionIDprotected
GetSessionVariableprotected
SetSessionVariableprotected
CreatepublicCreates a new session instance
InitSessionpublicInitializes the session from HTTP request
InitResponsepublicInitializes the HTTP response for the session
UpdateResponsepublicUpdates the HTTP response with session information
RemoveVariablepublicRemoves a variable from the session
RegenerateSessionIDpublic
TerminatepublicTerminates and invalidates the session
SessionVariableExistspublicChecks if a session variable exists

Events

OnSessionStateChangepublicEvent triggered when session state changes

Inherited

From TComponent (75)

_AddRef _Release BeforeDestruction CanObserve ChangeName ComObject ComponentCount ComponentIndex Components ComponentState ComponentStyle DefineProperties DesignInfo Destroy DestroyComponents Destroying ExecuteAction FindComponent FreeNotification FreeOnRelease GetChildOwner GetChildParent GetChildren GetDeltaStreams GetEnumerator GetIDsOfNames GetNamePath GetObservers GetOwner GetParentComponent GetTypeInfo GetTypeInfoCount HasParent iicrGetComponent InsertComponent Invoke IsImplementorOf Loaded Loading Name Notification ObserverAdded Observers OnGetDeltaStreams Owner PaletteCreated QueryInterface ReadDeltaState ReadDeltaStream ReadState ReferenceInterface RemoveComponent RemoveFreeNotification RemoveFreeNotifications SafeCallException SetAncestor SetChildOrder SetDesigning SetDesignInstance SetInline SetName SetParentComponent SetSubComponent Tag ToString TToStringNameMode UpdateAction Updated UpdateRegistry Updating ValidateContainer ValidateInsert ValidateRename VCLComObject WriteState

From TPersistent (5)

Assign AssignTo FPOAttachObserver FPODetachObserver FPONotifyObservers

From TObject (37)

AfterConstruction CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandler DefaultHandlerStr Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName newinstance QualifiedClassName StringMessageTable SystemHasExtendedRTTI UnitName

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.