TCP/IP class. More...

#include <fbio.h>

Inheritance diagram for FBTCPIP:

[legend]

Public Member Functions
	FBTCPIP ()
	Constructor.

bool	Read (int pSocket, void lpBuffer, int nNumberOfBytesToRead, int lpNumberOfBytesRead=NULL)
	Read data from a network socket (non-blocking)

bool	ReadBlocking (int pSocket, void lpBuffer, int nNumberOfBytesToRead, int lpNumberOfBytesRead=NULL, kULong pTimeOut=500)
	Read data from a network socket (blocking).

bool	ReadDatagram (int pSocket, void lpBuffer, int nNumberOfBytesToRead, int lpNumberOfBytesRead=NULL, kULong pAddr=NULL, unsigned short pPort=NULL)
	Read datagram from a network socket.

bool	Write (int pSocket, void lpBuffer, int nNumberOfBytesToWrite, int lpNumberOfBytesWritten=NULL)
	Write data to a network socket (non-blocking)

bool	WriteBlocking (int pSocket, void lpBuffer, int nNumberOfBytesToWrite, int lpNumberOfBytesToWrite=NULL, kULong pTimeOut=500)
	Write data to a network socket (blocking)

bool	WriteDatagram (int pSocket, void lpBuffer, int nNumberOfBytesToWrite, int lpNumberOfBytesToWrite, kULong pAddr, unsigned short pPort)
	Write a datagram to a network socket.

bool	CreateSocket (int &pSocket, FBTCPIPSocketType pType, const char *pProtocol="ip", bool pNonBlocking=true)
	Create a network socket.

bool	Bind (int &pSocket, kULong pAddr, int pPort=0)
	Bind a socket to an address.

bool	Connect (int &pSocket, char *pAddr, int pPort)
	Connect to address pAddr, port pPort with socket pSocket.

bool	CloseSocket (int &pSocket)
	Close a network socket.

int	Listen (int pSocket, int pBackLog=1)
	Place socket in mode to receive data.

int	Accept (int pSocket, kULong *pOutAddr=NULL)
	Accepts incoming port access.

int	Select (int pSocket, bool pTestRead, bool pTestWrite, bool pTestError, kULong pTimeOutMilisecond=0)
	Test socket status.

Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor.

virtual	~FBComponent ()
	Destructor.

virtual bool	FBCreate ()
	Open Reality Creation function.

virtual void	FBDestroy ()
	Open Reality destruction function.

virtual void	FBDelete () override
	Open Reality deletion function.

virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer.

virtual int	PropertyAdd (FBProperty *pProperty)
	Add a property to the component's property manager.

bool	PropertyAddReferenceProperty (FBProperty *pReferenceProperty)
	Add a reference property to the component's property manager.

void	PropertyRemove (FBProperty *pProperty)
	Remove a Property from the component's Property manager.

void	PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property.

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.

void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.

void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.

void	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy.

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace.

virtual const char *	ClassName () override
	Get the class name.

virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not.

const char *	GetFullName (void)
	Get the full name.

void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object.

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object.

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object.

void	HardSelect ()
	HardSelect.

virtual bool	Is (int pTypeId) override
	Returns true if object is of type TypeId.

virtual int	GetTypeId () override
	GetTypeId( int pTypeId )

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject.

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Additional Inherited Members
Static Public Member Functions inherited from FBComponent
static int	GetInternalClassId ()

static void	FBComponentSetName (FBComponent pObject, const char pName)

static const char *	FBComponentGetName (FBComponent *pObject)

static void	FBComponentSetLongName (FBComponent pObject, const char pName)

static const char *	FBComponentGetLongName (FBComponent *pObject)

Public Attributes inherited from FBComponent
FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component.

FBPropertyListComponent	Components
	List: List of components.

FBPropertyListComponent	Parents
	List: Parents.

FBPropertyBool	Selected
	Read Write Property: Selected property.

FBPropertyString	Name
	Read Write Property: Unique name of object.

FBPropertyString	LongName
	Read Write Property: Name and namespace for object.

FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component.

Static Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object.

Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component.

bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection.

bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection.

void	DisconnectAllSrc ()
	Remove all source connections.

void	DisconnectAllDst ()
	Remove all destination connections.

bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index.

bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index.

bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index.

bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index.

bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B.

bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex.

bool	MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc.

int	GetSrcCount ()
	Get source connection count.

FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index.

FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index.

int	GetDstCount ()
	Get destination connection count.

FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index.

FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index.

bool	BeginChange ()
	Begins a change on multiple plugs.

void	EndChange ()
	Ends a change on multiple plugs.

void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag.

bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed.

void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag.

bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed.

int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List.

bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status.

void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag.

bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed.

FBPlug *	GetOwner ()
	Get the owner of this plug.

FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index.

int	GetOwnedCount ()
	Get the owned plug count.

virtual const char *	ClassName ()
	internal System vars.

virtual bool	Is (int pTypeId)
	Is( int pTypeId )

virtual int	GetTypeId ()
	GetTypeId( int pTypeId )

virtual bool	PlugDataNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only.

virtual bool	PlugStateNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only.

virtual bool	PlugNotify (FBConnectionAction pAction, FBPlug pThis, int pIndex, FBPlug pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
	PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only.

virtual void	FBDelete ()
	Actual destructor for a FBPlug.

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id.

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component.

HIObject	mObject
	Handle on the Plug.

bool	mSDKComponent
	bool Plug is an SDK component.

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object.

static int	TypeInfo
	TypeInfo.

static int	mGlobalTypeInfo
	Represente the Type Index.

Detailed Description

TCP/IP class.

Definition at line 206 of file fbio.h.

Constructor & Destructor Documentation

◆ FBTCPIP()

FBTCPIP ( )

Constructor.

Member Function Documentation

◆ Accept()

int Accept	(	int	pSocket,
		kULong *	pOutAddr = `NULL`
	)

Accepts incoming port access.

Parameters

pSocket Network socket.

Return values

pOutAddr Buffer receiving address of sender.

Returns: Error code from operation (returns 0 if no error)

◆ Bind()

bool Bind	(	int &	pSocket,
		kULong	pAddr,
		int	pPort = `0`
	)

Bind a socket to an address.

Parameters

pSocket	Network socket.
pAddr	Address to bind socket to.
pPort	Port of pAddr to bind.

Returns: true if successful.

◆ CloseSocket()

bool CloseSocket ( int & pSocket )

Close a network socket.

Parameters

pSocket Network socket.

Returns: true if successful.

◆ Connect()

bool Connect	(	int &	pSocket,
		char *	pAddr,
		int	pPort
	)

Connect to address pAddr, port pPort with socket pSocket.

Parameters

pSocket	Network socket.
pAddr	Address to connect to.
pPort	Port at pAddr to use.

Returns: true if successful.

◆ CreateSocket()

bool CreateSocket	(	int &	pSocket,
		FBTCPIPSocketType	pType,
		const char *	pProtocol = `"ip"`,
		bool	pNonBlocking = `true`
	)

Create a network socket.

Return values

pSocket Network socket created.

Parameters

pType	Type of network socket.
pProtocol	Protocol to use to communicate.
pNonBlocking	Is socket blocking or non-blocking?

Returns: true if successful.

◆ Listen()

int Listen	(	int	pSocket,
		int	pBackLog = `1`
	)

Place socket in mode to receive data.

Parameters

pSocket	Network socket.
pBackLog	Maximum length of the queue of pending connections (default is 1).

Returns: Error code from operation (returns 0 if no error)

◆ Read()

bool Read	(	int	pSocket,
		void *	lpBuffer,
		int	nNumberOfBytesToRead,
		int *	lpNumberOfBytesRead = `NULL`
	)

Read data from a network socket (non-blocking)

Parameters

pSocket Network socket.

Return values

lpBuffer Buffer to fill.

Parameters

nNumberOfBytesToRead Number of bytes to read.

Return values

lpNumberOfBytesRead Number of bytes actually read (if not at NULL).

Returns: true if the number of bytes read is equal to the number of bytes requested.

◆ ReadBlocking()

bool ReadBlocking	(	int	pSocket,
		void *	lpBuffer,
		int	nNumberOfBytesToRead,
		int *	lpNumberOfBytesRead = `NULL`,
		kULong	pTimeOut = `500`
	)

Read data from a network socket (blocking).

Parameters

pSocket Network socket.

Return values

lpBuffer Buffer to fill.

Parameters

nNumberOfBytesToRead Number of bytes to read.

Return values

lpNumberOfBytesRead Number of bytes actually read (if not at NULL).

Parameters

pTimeOut Timeout for operation (default to DEFAULT_BLOCKING).

Returns: true if the number of bytes read is equal to the number of bytes requested.

Warning: This operation is blocking!

◆ ReadDatagram()

bool ReadDatagram	(	int	pSocket,
		void *	lpBuffer,
		int	nNumberOfBytesToRead,
		int *	lpNumberOfBytesRead = `NULL`,
		kULong *	pAddr = `NULL`,
		unsigned short *	pPort = `NULL`
	)

Read datagram from a network socket.

Parameters

pSocket Network socket.

Return values

lpBuffer Buffer to fill.

Parameters

nNumberOfBytesToRead Number of bytes to read.

Return values

lpNumberOfBytesRead Number of bytes actually read (if not at NULL).

Parameters

pAddr	Address to get datagram.
pPort	Port to access at pAddr.

Returns: true if the number of bytes read is equal to the number of bytes requested.

◆ Select()

int Select	(	int	pSocket,
		bool	pTestRead,
		bool	pTestWrite,
		bool	pTestError,
		kULong	pTimeOutMilisecond = `0`
	)

Test socket status.

Parameters

pSocket	Network socket to test.
pTestRead	Test for read?
pTestWrite	Test for write?
pTestError	Test for error?
pTimeOutMilisecond	Timeout for operation.

Returns: Error code from operation (returns 0 if no error)

◆ Write()

bool Write	(	int	pSocket,
		void *	lpBuffer,
		int	nNumberOfBytesToWrite,
		int *	lpNumberOfBytesWritten = `NULL`
	)

Write data to a network socket (non-blocking)

Parameters

pSocket	Network socket.
lpBuffer	Buffer to write.
nNumberOfBytesToWrite	Number of bytes to write.

Return values

lpNumberOfBytesWritten Number of bytes actually written (if not at NULL).

Returns: true if the number of bytes written is equal to the number of bytes to write.

◆ WriteBlocking()

bool WriteBlocking	(	int	pSocket,
		void *	lpBuffer,
		int	nNumberOfBytesToWrite,
		int *	lpNumberOfBytesToWrite = `NULL`,
		kULong	pTimeOut = `500`
	)

Write data to a network socket (blocking)

Parameters

pSocket	Network socket.
lpBuffer	Buffer to write.
nNumberOfBytesToWrite	Number of bytes to write.

Return values

lpNumberOfBytesToWrite Number of bytes actually written (if not at NULL).

Parameters

pTimeOut Timeout for operation.

Returns: true if the number of bytes written is equal to the number of bytes to write.

Warning: This operation is blocking!

◆ WriteDatagram()

bool WriteDatagram	(	int	pSocket,
		void *	lpBuffer,
		int	nNumberOfBytesToWrite,
		int *	lpNumberOfBytesToWrite,
		kULong	pAddr,
		unsigned short	pPort
	)

Write a datagram to a network socket.

Parameters

pSocket	Network socket.
lpBuffer	Buffer to write.
nNumberOfBytesToWrite	Number of bytes to write.

Return values

lpNumberOfBytesToWrite Number of bytes actually written (if not at NULL).

Parameters

pAddr	Address to write datagram.
pPort	Port to access at pAddr.

Returns: Number of bytes written.

The documentation for this class was generated from the following file:

fbio.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBTCPIP()

Member Function Documentation

◆ Accept()

◆ Bind()

◆ CloseSocket()

◆ Connect()

◆ CreateSocket()

◆ Listen()

◆ Read()

◆ ReadBlocking()

◆ ReadDatagram()

◆ Select()

◆ Write()

◆ WriteBlocking()

◆ WriteDatagram()