VCDoc
Class Tree

Class
  unaVC_pipe.unavclInOutPipe

Class Hierarchy
  / TComponent / TPersistent / TObject

Description
 

Base abstract class for all components.

Members
  Fields
 
Field Description

Methods
 
Method Description
addConsumer Adds new consumer for the pipe.
addProvider Adds new provider for the pipe.
AfterConstruction Creates list of consumers and providers, internal critical section and data proxy thread.
applyFormat Applies new format of the data stream.
BeforeDestruction Destroys the pipe.
checkIfAutoActivate Checks if autoActivate property is True and activates/deactivates consumers if yes.
checkIfFormatProvider Checks if component is format provider and applies format to consumer if it is (and format was not applied before).
clearFormatCRC Forces component to assign its format to consumers (if isFormatProvider is True).
close Closes the pipe.
doAddConsumer Adds new consumer for the pipe.
doAddProvider Assigns new provider for the pipe.
doBeforeAfterFC Calls f_beforeFormatChange or f_afterFormatChange if assigned.
doClose Closes the pipe.
doEnter Enters internal critical section.
doGetPosition Implements positions retrieval routine.
doLeave Leaves internal critical section.
doOpen Opens the pipe.
doRead Reads data from the pipe.
doRemoveConsumer Removes consumer from the pipe.
doRemoveProvider Removes one of pipe's providers.
doSetActive Sets active state of the pipe.
doSetEnableDP Sets enableDataProcessing value.
doWrite Writes data into the pipe.
enter Enters the internal critical section.
getAvailableDataLen Returns data size available in the pipe (bytes).
getConsumer Returns consumer.
getConsumerCount Returns number of consumers.
getConsumerIndex Returns index of consumer.
getFormatExchangeData Fills the format of the data stream.
getPosition Returns position in stream.
getProvider Returns provider.
getProviderCount Returns number of providers.
getProviderIndex Returns index of provider.
incInOutBytes Increments (or decrements in/outBytes property by delta.
isActive Returns component's active state.
leave Leaves Enters the internal critical section.
Loaded Usually creates an internal device of the pipe, and activates the component if needed.
Notification IDE/VCL notification for components removal/insertion.
notifyConsumers Notify all consumers there is no more such provider (self).
notifyProviders Notify all providers there is new consumer (self), or consumer is removed (value = nil).
onNewData Processes new data available from the pipe.
open Opens the pipe.
READ If you did not specify the consumer for the pipe, you must call
READ Reads data as a string.
removeConsumer Removes consumer from the pipe.
removeProvider Removes one of pipe's providers.
WRITE Writes data into the pipe.
WRITE Writes data into the pipe.

Properties
 
Property Description
active Returns or sets the active state of the pipe.
autoActivate When True tells the component it must activate consumer (if any)
availableDataLenIn Returns data written into but not yet processed by the pipe.
availableDataLenOut Returns data size available to read from the pipe.
closing True if component is being closed.
consumer Specifies the consumer of component.
consumers Array of component consumers.
dumpInput Specifies the file name to store the stream into.
dumpOutput Specifies the file name to store the stream into.
enableDataProcessing Specifies whether the component would perform any data processing.
enableDataProxy Data will be placed to proxy thread before processing.
inBytes Number of bytes received by the pipe.
isFormatProvider When True the component will assign stream format to the consumer (if any).
onDataAvailable This event is fired every time component has produced or received new chunk of data.
onDataDSP This event is fired every time component has produced or received new
onFormatChangeAfter This event is fired after new format was applied to a pipe.
onFormatChangeBefore This event is fired before new format is about to be applied to a pipe.
opt Internal.
outBytes Number of bytes produced by the pipe.
position Current position in stream (if applicable).
providerOneAndOnly Returns first provider of a component (if any).
providers Array of providers for component.
_consumers List of consumers.
_providers List of providers.


(c) 2001-2008 Lake of Soft, Ltd
Created with DelphiCodeToDoc.