Datasnap.DSSession.TDSTCPSession Methods

From RAD Studio API Documentation
Jump to: navigation, search


InheritedProtected
AfterConstructionpublicResponds after the last constructor has executed.
AssignpublicCopies the contents of another similar object.
AssignToprotectedCopies the properties of an object to a destination object.
AuthenticatepublicRepresents an extension of Authenticate to wrap the TCP authentication manager call.
AuthorizepublicChecks that the user of the current session has authorization for the given event.
BeforeDestructionpublicResponds before the first destructor executes.
CancelScheduledEventpublicCancels the last scheduled event.
CheckDisposedprotected
CheckTransientprotectedRaises an exception if the session corresponds to a transient session.
ClassInfopublicReturns a pointer to the run-time type information (RTTI) table for the object type.
ClassNamepublicReturns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
ClassNameIspublicDetermines whether an object is of a specific type.
ClassParentpublicReturns the type of the immediate ancestor of a class.
ClassTypepublicReturns the class reference for the object's class.
CleanupInstancepublicPerforms finalization on long strings, variants, and interface variables within a class.
ClosepublicCloses the communication channel.
CreatepublicCreates an instance of a TCP session.
DefaultHandlerpublicProvides the interface for a method that processes message records.
DefinePropertiesprotectedProvides an interface for a method that reads and writes otherwise unpublished data.
Destroypublic
DispatchpublicCalls message-handling methods for the object, based on the contents of the Message parameter.
DisposeOfpublicDisposeOf forces the execution of the destructor code in an object.
ElapsedSinceLastActvitypublicReturns the time elapsed since the last activity, in milliseconds.
EqualspublicChecks whether the current instance and the Obj parameter are equal.
ExpiresInpublicReturns the number of milliseconds remaining before the session expires.
FieldAddresspublicReturns the address of a published object field.
FreepublicDestroys an object and frees its associated memory, if necessary.
FreeInstancepublicDeallocates memory allocated by a previous call to the NewInstance method.
GenerateSessionIdpublicGenerates a unique session ID.
GetAuthRoleInternalprotectedReturns authorized and denied roles for a given server method, and caches the result.
GetAuthRolespublicGets authorized and denied roles associated with the given server method.
GetDatapublicRetrieves a value string stored in this session for the given key.
GetDisposedprotectedGetter for the Disposed property.
GetHashCodepublicReturns an integer containing the hash code.
GetIdprotectedReturns the current session's ID.
GetInterfacepublicRetrieves a specified interface.
GetInterfaceEntrypublicReturns the entry for a specific interface implemented in a class.
GetInterfaceTablepublicReturns a pointer to a structure containing all of the interfaces implemented by a given class.
GetNamePathpublicReturns the name of the object as it appears in the Object Inspector.
GetObjectpublicRetrieves an object stored in this session, for the given Key.
GetOwnerprotectedReturns the owner of an object.
GetSessionStatusprotectedReturns the session status.
HasDatapublicReturns whether the session holds data for the given key.
HasObjectpublicReturns whether the session holds an object for the given Key.
InheritsFrompublicDetermines the relationship of two object types.
InitInstancepublicInitializes a newly allocated object instance to all zeros and initializes the instance's virtual method table pointer.
InstanceSizepublicReturns the size in bytes of each instance of the object type.
IsIdleprotectedSpecifies whether the session is idle.
IsIdleMSprotectedReturns whether the session did not have any activity for the number of specified milliseconds.
IsValidpublicReturns True if the status is Active, Connected, or Idle.
MarkActivitypublicMarks the current session as active.
MethodAddresspublicReturns the address of a class method by name.
MethodNamepublicReturns the name of a class method by address.
NewInstancepublicAllocates memory for an instance of an object type and returns a pointer to that new instance.
PutDatapublicStores a value string in this session, with the given key.
PutObjectpublicStores an object in this session with the given Key.
QualifiedClassNamepublicReturns the qualified name of the class.
RemoveDatapublicRemoves a value string from this session that matches the given key.
RemoveObjectpublicRemoves an object that matches the given Key from this session.
RequiresAuthorizationpublicReturns whether the given method requires authorization.
SafeCallExceptionpublicHandles exceptions in methods declared using the safecall calling convention.
ScheduleInactiveTerminationEventpublicSchedules a session termination event if the session is inactive.
ScheduleTerminationEventpublicSchedules a session termination event at a specified moment.
ScheduleUserEventpublicSchedules an event to be run at a specified moment.
TerminatepublicTerminates the session.
TerminateInactiveSessionprotectedTerminates the session if it is inactive.
TerminateSessionprotectedTerminates the current session.
ToStringpublicReturns a string containing the class name.
UnitNamepublicReturns the name of the unit where the class is defined.
UnitScopepublicReturns the class's unit scope.