| ppcstype1serversbme | ||
|---|---|---|
 | Chapter 7. The PPCS Server for SBME Databases (PPSR) Component |  |
ppcstype1serversbme
Description
A ppcstype1serversbme object represents an SBME database file which a ppcstype1server object makes available to PPCS clients.
Type Tags
None
Object Value
Properties
| Property | Type | Description |
|---|---|---|
| _ | type(*) | This property is provided for use by the user to attach any object of any type to the type in which this property is provided. |
| __ | type(*) | This property is provided for use by the user to attach any object of any type to the type in which this property is provided. It has the additional feature of being marked with the resolve keyword, so that object resolution can continue down this property. |
| cachesize | integer | Specifies the amount of memory currently available for caching the new SBME file. |
| committype | string |
Specifies when changes to the SBME file are to be committed. If this is ""
then changes are committed only when the commit
method is called for the SBME object. If the committype is
"auto" then changes are committed after every
change is complete. Committing after every change means that the
SBME file is more secure against system or programming errors, but
there may be a performance penalty.
|
| filename | string | Gives the name of the SBME file. |
| firsttable | ppcstype1servertable | Specifies the object which represents the first table in the SBME file. |
| locktimeout | integer |
Gives the length of time that a record lock is respected for, measured in
microseconds. When a client locks a record (or all records for a
table) then that lock must be released by the client within the
locktimeout time period. If not then the server
will release the lock, and the client may encounter an error if it
attempts an operation which assumes that the lock is still in place.
A locktimeout of .inf means
that the server will never automatically release records locks for
tables in the SBME file.
|
| next | ppcstype1serversbme | Gives the next SBME file for the same ppcstype1server object. |
| server | ppcstype1server | Specifies the server to which this SBME file belongs. |
| type | type | Specifies the ppcstype1serversbme type object. |
Methods
commit()
Description
Commits all changes to the SBME file.
Prototype
ppcstype1serversbmevar.commit (
integer error
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| error | .nul | integer |
Specifies an object which is used to output any error code generated during
the committing of data. If error is not
specified or is .nul then any error which
occurs during committing of data will halt the program. If an
error object is specified and an error occurs during the
committing of data then the error code is output into that object
and the method returns .nul.
|
remove()
Description
Removes a SBME file from the ring of SBME files for the server. The file is then available for use by other servers, although some operating systems will not allow it to be used until a platform specific short time period has elapsed.
Prototype
ppcstype1serversbmevar.remove ()
Parameters
None
setcachesize()
Description
Determines how much memory is used for caching data from the SBME file.
Prototype
ppcstype1serversbmevar.setcachesize (
integer cachesize
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| cachesize | None | integer | Specifies the amount of memory to reserve for caching for the SBME file. |
setcommittype()
Description
Determines when changes to the SBME file are committed.
Prototype
ppcstype1serversbmevar.setcommittype (
string committype
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| committype | None | string |
Specifies when changes to the SBME file are to be committed. If this is ""
then changes are committed only when the
commit method is called for the SBME object.
If the committype is "auto" then changes are
committed after every change is complete. Committing after every
change means that the SBME file is more secure against system
or programming errors, but there may be a performance penalty.
|
setlocktimeout()
Description
Determines how long client's record locks are respected for.
Prototype
ppcstype1serversbmevar.setlocktimeout (
integer locktimeout
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| locktimeout | None | integer |
Gives the length of time that a record lock is respected for, measured in
microseconds. When a client locks a record (or all records for a
table) then that lock must be released by the client within the
locktimeout time period. If not then the
server will release the lock, and the client may encounter an
error if it attempts an operation which assumes that the lock is
still in place. A locktimeout of
.inf means that the server will never
automatically release records locks for tables in the SBME
file.
|