ePages 6.10 - DE_EPAGES/WebInterfacePoolDB/API/Table/ASServer.pm

Package DE_EPAGES::WebInterfacePoolDB::API::Table::ASServer

interface for table ASServer

@EXPORT_OK
InsertASServer
UpdateASServer
DeleteASServer
GetAllPKeyASServers
GetAllInfoASServers
GetInfoASServer
ExistsASServer
GetPKeyASServersByPoolID
GetInfoASServersByPoolID
GetPKeyASServerByIP
GetInfoASServerByIP
ExistsASServerByIP
GetPKeyASServersByIP
GetInfoASServersByIP

Functions

DeleteASServer
ExistsASServer
ExistsASServerByIP
GetAllInfoASServers
GetAllPKeyASServers
GetInfoASServer
GetInfoASServerByIP
GetInfoASServersByIP
GetInfoASServersByPoolID
GetPKeyASServerByIP
GetPKeyASServersByIP
GetPKeyASServersByPoolID
InsertASServer
UpdateASServer

DeleteASServer

Deletes a(n) ASServer.

Syntax
DeleteASServer($ASServerID);
DeleteASServer($hASServer); # if $hASServer includes ASServerID
Input
$ASServerID (int)
application server id (primary key)

ExistsASServer

Returns true if the ASServer exists.

Syntax
$exists = ExistsASServer($ASServerID);
Input
$ASServerID (int)
application server id
Return
$exists (boolean)
1/0 the ASServer exists (yes/no)

ExistsASServerByIP

Returns true if a ASServer by alternate keys IP and Port exists.

Syntax
$ASServerID = ExistsASServerByIP($IP, $Port);
Input
$IP (text)
ip address
$Port (int)
port
Return
$exists (boolean)
1/0 the u_asserver_ip_port exists (yes/no)

GetAllInfoASServers

Returns all objects of ASServer.

Syntax
$ahASServers = GetAllInfoASServers();
Return
$ahASServers (reference to array of hashes)
with following keys:
  • ASServerID - application server id (primary key)- int
  • IP - ip address - text
  • Port - port - int
  • PoolID - pool id (optional)- int
  • Priority - priority, higher numbers mean higher priority - int

GetAllPKeyASServers

Returns all ASServer identifiers.

Syntax
$aASServerIDs = GetAllPKeyASServers();
Return
$aASServerIDs (reference to array of int)
application server id

GetInfoASServer

Returns the ASServer by identifier.

Syntax
$hASServer = GetInfoASServer($ASServerID);
Input
$ASServerID (int)
application server id (primary key)
Return
$hASServer (reference to hash)
with following keys:
  • ASServerID - application server id (primary key)- int
  • IP - ip address - text
  • Port - port - int
  • PoolID - pool id (optional)- int
  • Priority - priority, higher numbers mean higher priority - int

GetInfoASServerByIP

Returns the object of ASServer by alternate keys IP and Port.

Syntax
$hASServer = GetInfoASServerByIP($IP, $Port);
Input
$IP (text)
ip address
$Port (int)
port
Return
$hASServer (reference to hash)
with following keys:
  • ASServerID - application server id (primary key)- int
  • IP - ip address - text
  • Port - port - int
  • PoolID - pool id (optional)- int
  • Priority - priority, higher numbers mean higher priority - int

GetInfoASServersByIP

Returns objects of ASServer by alternate keys IP and Port.

Syntax
$ahASServers = GetInfoASServersByIP($IP, $Port);
Input
$IP (text)
ip address
$Port (int)
port (optional)
Return
$ahASServers (reference to array of hashes)
with following keys:
  • ASServerID - application server id (primary key)- int
  • IP - ip address - text
  • Port - port - int
  • PoolID - pool id (optional)- int
  • Priority - priority, higher numbers mean higher priority - int

GetInfoASServersByPoolID

Returns objects of ASServer by alternate key PoolID.

Syntax
$ahASServers = GetInfoASServersByPoolID($PoolID);
Input
$PoolID (int)
pool id
Return
$ahASServers (reference to array of hashes)
with following keys:
  • ASServerID - application server id (primary key)- int
  • IP - ip address - text
  • Port - port - int
  • PoolID - pool id (optional)- int
  • Priority - priority, higher numbers mean higher priority - int

GetPKeyASServerByIP

Returns primary key of ASServer by alternate keys IP and Port.

Syntax
$ASServerID = GetPKeyASServerByIP($IP, $Port);
Input
$IP (text)
ip address
$Port (int)
port
Return
$ASServerID (int)
application server id (primary key)

GetPKeyASServersByIP

Returns primary keys of ASServer by alternate keys IP and Port.

Syntax
$aKeys = GetPKeyASServersByIP($IP, $Port);
Input
$IP (text)
ip address
$Port (int)
port (optional)
Return
$aKeys (reference to array of int)
application server id (primary key)

GetPKeyASServersByPoolID

Returns primary keys of ASServer by alternate key PoolID.

Syntax
$aKeys = GetPKeyASServersByPoolID($PoolID);
Input
$PoolID (int)
pool id
Return
$aKeys (reference to array of int)
application server id (primary key)

InsertASServer

Creates an entry of ASServer.

Syntax
$ASServerID = InsertASServer($hASServer);
Input
$hASServer (reference to hash)
with following keys:
  • ASServerID - application server id (primary key)(optional)- int
  • IP - ip address - text
  • Port - port - int
  • PoolID - pool id (optional)- int
  • Priority - priority, higher numbers mean higher priority - int
Return
$ASServerID (int)
application server id (primary key)

UpdateASServer

Updates a(n) ASServer if any element was changed.

Syntax
UpdateASServer($ASServerID, $hASServer);
UpdateASServer($hASServer); # if $hASServer includes ASServerID
Input
$ASServerID (int)
application server id (primary key)
$hASServer (reference to hash)
with following keys:
  • IP - ip address - text
  • Port - port - int
  • PoolID - pool id (optional)- int
  • Priority - priority, higher numbers mean higher priority - int