SFBPort1

Wrapper Class for the IPort1 interface.

#include <SFBPort1.h.hpp>

class SFBPort1 : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBPort1)

Inheritance diagram

Version

BREW 2.0	BREW 2.1	BREW 3.1	BREW 4.0
X	X	O	O

Reference

BREW API IPort1

Member

Public Functions
`SFCError`	Close( `Void` ) Closes the port.
`SFCError`	Control( `AEEUID` uid , `ByteConstPtr` in , `SInt32` inLen , `BytePtr` out , `SInt32` outLen , `SInt32Ptr` outLenreq ) Allow some control over the behaviour of an IPort1, e.g. setting/getting configuration.
`SFCError`	Control( `AEEUID` uid , `SFXBufferConstRef` in , `SFXBufferPtr` out ) Allow some control over the behaviour of an IPort1, e.g. setting/getting configuration.
static `SFBPort1Smp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBPort1 instance.
static `SFBPort1Smp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBPort1 instance.
`SFCError`	Read( `BytePtr` buffer , `SInt32` length , `SInt32Ptr` read ) Copy bytes from the source stream to the specified buffer.
`SFCError`	Read( `SFXBufferPtr` buffer , `SInt32Ptr` read ) Copy bytes from the source stream to the specified buffer.
`SFCError`	Readable( `SFBSignalSmpConstRef` signal ) Schedule a function to be called when Read() would return something other than AEE_EWOULDBLOCK.
`SFCError`	Write( `ByteConstPtr` buffer , `SInt32` length , `SInt32Ptr` written ) Copy bytes from the specified buffer to the source stream.
`SFCError`	Write( `SFXBufferConstRef` buffer , `SInt32Ptr` written ) Copy bytes from the specified buffer to the source stream.
`SFCError`	Writeable( `SFBSignalSmpConstRef` signal ) Schedule a function to be called when Write() would return something other than AEE_EWOULDBLOCK.
`SFCError`	QueryInterface( `AEECLSID` clsid , `VoidHandle` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFCError`	QueryInterface( `AEECLSID` clsid , `SFBBaseSmpPtr` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFBBaseSmp`	QueryInterface( `AEECLSID` clsid ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`Void`	Self( `AEECLSID` clsidReq , `SFBQuerySmpPtr` clone , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.
`SFBQuerySmp`	Self( `AEECLSID` clsidReq , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.

Protected Functions
static `SFBBaseSmp`	FactoryByCreate( `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface.
static `SFBBaseSmp`	FactoryByQuery( `SFBQuerySmpConstRef` query , `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface using the SFBQuery instance.

SFBPort1::Close

Closes the port.

[ public ]
SFCError Close(Void);

Reference

BREW API IPort1_Close

SFBPort1::Control

Allow some control over the behaviour of an IPort1, e.g. setting/getting configuration.

[ public ]
SFCError Control(
    AEEUID uid            // uid of the control operation
    ByteConstPtr in       // input buffer argument for the operation
    SInt32 inLen          // length of input
    BytePtr out           // output buffer argument for the operation, filled up to nOutLen bytes of the result of the operation, if any
    SInt32 outLen         // length of output
    SInt32Ptr outLenreq   // set to length of output required to complete the operation
);

[ public ]
SFCError Control(
    AEEUID uid             // uid of the control operation
    SFXBufferConstRef in   // input buffer argument for the operation
    SFXBufferPtr out       // output buffer argument for the operation
);

Reference

BREW API IPort1_Control

SFBPort1::NewInstance

Create a new SFBPort1 instance.

[ public, static ]
SFBPort1Smp NewInstance(
    SFCErrorPtr exception = null   // Error
);

[ public, static ]
SFBPort1Smp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);

SFBPort1::Read

Copy bytes from the source stream to the specified buffer.

[ public ]
SFCError Read(
    BytePtr buffer   // pointer to buffer to receive bytes read
    SInt32 length    // size of buffer
    SInt32Ptr read   // the number of bytes read successfully
);

[ public ]
SFCError Read(
    SFXBufferPtr buffer   // buffer to receive bytes read
    SInt32Ptr read        // the number of bytes read successfully
);

Reference

BREW API IPort1_Read

SFBPort1::Readable

Schedule a function to be called when Read() would return something other than AEE_EWOULDBLOCK.

[ public ]
SFCError Readable(
    SFBSignalSmpConstRef signal   // smart pointer to a signal that is associated with a callback function that can be invoked when the port may be read with Read()
);

Reference

BREW API IPort1_Readable | SFBSignal

SFBPort1::Write

Copy bytes from the specified buffer to the source stream.

[ public ]
SFCError Write(
    ByteConstPtr buffer   // pointer to buffer from which bytes are taken to write to the port
    SInt32 length         // size of data in buffer
    SInt32Ptr written     // size of data written to the Port
);

[ public ]
SFCError Write(
    SFXBufferConstRef buffer   // buffer from which bytes are taken to write to the port
    SInt32Ptr written          // size of data written to the Port
);

Reference

BREW API IPort1_Write

SFBPort1::Writeable

Schedule a function to be called when Write() would return something other than AEE_EWOULDBLOCK.

[ public ]
SFCError Writeable(
    SFBSignalSmpConstRef signal   // smart pointer to a signal that is associated with a callback function that can be invoked when the port may be written with Write()
);

Reference

BREW API IPort1_Writeable | SFBSignal