Package FairCom.CtreeDb.Types

Class SESSION_PARAM

Object
SESSION_PARAM
public final class SESSION_PARAM extends Object
Session parameter values used on a CTSession.SetParam(int, int) call

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CT_BUFS
    the number of index file buffers, minimum 3.
    static final int
    CT_DBUFS
    the number of buffers for data files I/O
    static final int
    CT_FILS
    initial block of file structures.
    static final int
    CT_SECT
    the number of node sectors.
    static final int
    CT_USERPROF
    is the user profile mask, and accepts the following values: SESSION_PARAM.USERPRF_CLRCHK SESSION_PARAM.USERPRF_LOCLIB SESSION_PARAM.USERPRF_NDATA SESSION_PARAM.USERPRF_NTKEY SESSION_PARAM.USERPRF_PTHTMP SESSION_PARAM.USERPRF_SAVENV
    static final int
    USERPRF_CLRCHK
    instructs single-user TRANPROC applications to remove S*.FCS and L*.FCS files upon a successful application shutdown.
    static final int
    USERPRF_LOCLIB
    specifies this instance of c-tree Plus is to be directed to a local database.
    static final int
    USERPRF_NDATA
    enable the manual mode of UNIFRMAT support.
    static final int
    USERPRF_NTKEY
    disables the automatic TransformKey() feature.
    static final int
    USERPRF_PTHTMP
    changes GetCtTempFileName() from its default operation of returning a temporary file name to specifying a directory name where temporary files are to reside.
    static final int
    USERPRF_SAVENV
    enable the automatic SAVENV feature.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SESSION_PARAM()
     

  • Method Summary

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • CT_BUFS

      public static final int CT_BUFS
      the number of index file buffers, minimum 3.
      See Also:

    • CT_FILS

      public static final int CT_FILS
      initial block of file structures.
      See Also:

    • CT_SECT

      public static final int CT_SECT
      the number of node sectors. Minimum of one required. sect multiplied by 128 equals the index node size.
      See Also:

    • CT_DBUFS

      public static final int CT_DBUFS
      the number of buffers for data files I/O
      See Also:

    • CT_USERPROF

      public static final int CT_USERPROF
      is the user profile mask, and accepts the following values: SESSION_PARAM.USERPRF_CLRCHK SESSION_PARAM.USERPRF_LOCLIB SESSION_PARAM.USERPRF_NDATA SESSION_PARAM.USERPRF_NTKEY SESSION_PARAM.USERPRF_PTHTMP SESSION_PARAM.USERPRF_SAVENV
      See Also:

    • USERPRF_CLRCHK

      public static final int USERPRF_CLRCHK
      instructs single-user TRANPROC applications to remove S*.FCS and L*.FCS files upon a successful application shutdown. The c-tree Plus checkpoint code determines at the time of a final checkpoint if there are no pending transactions or file opens, and if this user profile bit has been turned on. If so, the S*.FCS and L*.FCS files are deleted. However, if the application is causing log files to be saved (very unusual for a single-user application), then the files are not cleared. The USERPRF_CLRCHK option is off by default.
      See Also:

    • USERPRF_LOCLIB

      public static final int USERPRF_LOCLIB
      specifies this instance of c-tree Plus is to be directed to a local database. Applicable only to client/server when using "Local Library Support".
      See Also:

    • USERPRF_NDATA

      public static final int USERPRF_NDATA
      enable the manual mode of UNIFRMAT support. Enabling the manual record transformation mode would only be desirable when performing custom record level byte flipping or the record structures contain no numeric data (i.e., LONG, FLOAT, . . .). A side benefit of enabling this manual mode is the virtual elimination of Server DODA requests, thereby reducing network traffic by one function call per file open.
      See Also:

    • USERPRF_NTKEY

      public static final int USERPRF_NTKEY
      disables the automatic TransformKey() feature. See the Trans function description for more information.
      See Also:

    • USERPRF_PTHTMP

      public static final int USERPRF_PTHTMP
      changes GetCtTempFileName() from its default operation of returning a temporary file name to specifying a directory name where temporary files are to reside.
      See Also:

    • USERPRF_SAVENV

      public static final int USERPRF_SAVENV
      enable the automatic SAVENV feature. See the Begin() function description for more information.
      See Also:

  • Constructor Details

    • SESSION_PARAM

      public SESSION_PARAM()