de::gsi::bel::valueserver::ValueTree

de::gsi::bel::valueserver::ValueTree Class Reference

Inheritance diagram for de::gsi::bel::valueserver::ValueTree:

de::gsi::bel::valueserver::NodeAction List of all members.

Public Member Functions

Override boolean onNode (File_t file)
File_t findFile_r (File_t startNode, String filePath)

Static Public Member Functions

static int getGID ()
static int getUID ()

Protected Member Functions

 ValueTree (ValueServer vServer, String mive, String description, int major, int minor) throws ValueException
ValueSubscriber getValueSubscriber (String name, Xfer xfer)
void sendOnlineStatus (boolean online, Xfer xfer)
void sendOnlineStatus (boolean online)
void addValueSubscriber (ValueSubscriber vSub)
void rmValueSubscriber (ValueSubscriber vSub)
File_t[] findFiles (String filePath[])
void sendTriggerList (Subscriber_t subscriber)
Filevalue_u setFile (File_t file, Filevalue_u filevalue) throws ValueException
void addFile (File_t parentFile, File_t file) throws ValueException
void rmFile (File_t parentFile, String fileName) throws ValueException
void queuePush (File_t queueFile, File_t file)
Folder_t getRoot ()
File_t getRootFile ()
void pushOutput (ValueSubscriber vSub, Object o)
void flushOutput ()
void traverseDeleteSubscriber (Xfer xfer)
void procRequest (Request_t request, Xfer xfer)
void process (Subscribe_t sub, int id, boolean confirmed, Xfer xfer)
void process (Unsubscribe_t unsub, int id, boolean confirmed, Xfer xfer)
void process (Read_t read, int id, boolean confirmed, Xfer xfer)
void process (Write_t write, int id, boolean confirmed, Xfer xfer)
void process (Structurechange_t structureChange, int id, boolean confirmed, Xfer xfer)

Package Functions

BaseName buildBasename (String filePath)

Classes

class  BaseName

Detailed Description

Author:
huhmann

Constructor & Destructor Documentation

de::gsi::bel::valueserver::ValueTree::ValueTree ( ValueServer  vServer,
String  mive,
String  description,
int  major,
int  minor 
) throws ValueException [inline, protected]

creates the root node of this UV tree and set up a sender thread

Parameters:
vServer 
mive 
description 
major 
minor 
Exceptions:
ValueException 

Member Function Documentation

void de::gsi::bel::valueserver::ValueTree::addFile ( File_t  parentFile,
File_t  file 
) throws ValueException [inline, protected]

add a file to parent file

Parameters:
parentFile 
file 
Exceptions:
ValueException 

void de::gsi::bel::valueserver::ValueTree::addValueSubscriber ( ValueSubscriber  vSub  )  [inline, protected]

add a subscriber to the global list of all subscribers

Parameters:
vSub 

BaseName de::gsi::bel::valueserver::ValueTree::buildBasename ( String  filePath  )  [inline, package]

seprate filepath in first folder and rest

Parameters:
filePath 
Returns:

File_t de::gsi::bel::valueserver::ValueTree::findFile_r ( File_t  startNode,
String  filePath 
) [inline]

find recursively a file starting from some node

Parameters:
startNode node to start searching, null: start in root folder
filePath file name to look for
Returns:

File_t [] de::gsi::bel::valueserver::ValueTree::findFiles ( String  filePath[]  )  [inline, protected]

find for an array of absolute filenames the corresponding files and return an array of them

Parameters:
filePath 
Returns:

void de::gsi::bel::valueserver::ValueTree::flushOutput (  )  [inline, protected]

flush the output queue of all subscribers, this method is not directly called, but by the ValueSender thread

static int de::gsi::bel::valueserver::ValueTree::getGID (  )  [inline, static]

Group ID is not implemented right now

Returns:

Folder_t de::gsi::bel::valueserver::ValueTree::getRoot (  )  [inline, protected]

get the root folder of this value tree

Returns:

File_t de::gsi::bel::valueserver::ValueTree::getRootFile (  )  [inline, protected]

get the root file of this value tree

Returns:

static int de::gsi::bel::valueserver::ValueTree::getUID (  )  [inline, static]

User ID is not implemented right now

Returns:

Override boolean de::gsi::bel::valueserver::ValueTree::onNode ( File_t  file  )  [inline]

defines an action to take place on node

Parameters:
file node action is applied
Returns:
you may return a boolean to caller to indicate e.g. whether a tree traverse may continue or not

Implements de::gsi::bel::valueserver::NodeAction.

void de::gsi::bel::valueserver::ValueTree::process ( Structurechange_t  structureChange,
int  id,
boolean  confirmed,
Xfer  xfer 
) [inline, protected]

Process a client structure change request

Parameters:
structureChange 
id 
confirmed 
xfer 

void de::gsi::bel::valueserver::ValueTree::process ( Write_t  write,
int  id,
boolean  confirmed,
Xfer  xfer 
) [inline, protected]

Process a client write request

Parameters:
write 
id 
confirmed 
xfer 

void de::gsi::bel::valueserver::ValueTree::process ( Read_t  read,
int  id,
boolean  confirmed,
Xfer  xfer 
) [inline, protected]

Process a client read request

Parameters:
read 
id 
confirmed 
xfer 

void de::gsi::bel::valueserver::ValueTree::process ( Unsubscribe_t  unsub,
int  id,
boolean  confirmed,
Xfer  xfer 
) [inline, protected]

Process a client unsubscription

Parameters:
unsub 
id 
confirmed 
xfer 

void de::gsi::bel::valueserver::ValueTree::process ( Subscribe_t  sub,
int  id,
boolean  confirmed,
Xfer  xfer 
) [inline, protected]

Process a client subscription for a node

Parameters:
sub 
id 
confirmed 
xfer 

void de::gsi::bel::valueserver::ValueTree::procRequest ( Request_t  request,
Xfer  xfer 
) [inline, protected]

process a client request, here the request types are dispatched to specific request handlers

Parameters:
request 
xfer 

void de::gsi::bel::valueserver::ValueTree::pushOutput ( ValueSubscriber  vSub,
Object  o 
) [inline, protected]

push an object to output processing queue of an subscriber

Parameters:
vSub subscriber the object is send to
o object sent to subscriber

void de::gsi::bel::valueserver::ValueTree::queuePush ( File_t  queueFile,
File_t  file 
) [inline, protected]

push a file to queue file

Parameters:
queueFile 
file 

void de::gsi::bel::valueserver::ValueTree::rmFile ( File_t  parentFile,
String  fileName 
) throws ValueException [inline, protected]

remove a file by name from parent file

Parameters:
parentFile 
fileName 
Exceptions:
ValueException 

void de::gsi::bel::valueserver::ValueTree::rmValueSubscriber ( ValueSubscriber  vSub  )  [inline, protected]

remove a subscriber from the list of all subsribers

Parameters:
vSub 

void de::gsi::bel::valueserver::ValueTree::sendOnlineStatus ( boolean  online  )  [inline, protected]

for all clients send online status

Parameters:
online 

void de::gsi::bel::valueserver::ValueTree::sendOnlineStatus ( boolean  online,
Xfer  xfer 
) [inline, protected]

send online status to a client

Parameters:
online 
xfer 

void de::gsi::bel::valueserver::ValueTree::sendTriggerList ( Subscriber_t  subscriber  )  [inline, protected]

generate value change notifications for the trigger list of a node subscription

Parameters:
subscriber Node subscription

Filevalue_u de::gsi::bel::valueserver::ValueTree::setFile ( File_t  file,
Filevalue_u  filevalue 
) throws ValueException [inline, protected]

set file value

Parameters:
file 
filevalue 

void de::gsi::bel::valueserver::ValueTree::traverseDeleteSubscriber ( Xfer  xfer  )  [inline, protected]

traverse the complete UV tree and delete all subscriptions done on xfer

Parameters:
xfer 

The documentation for this class was generated from the following file:
Generated on 4 Mar 2014 for valueserver by  doxygen 1.4.7