SFBMcastSession

Wrapper Class for the IMcastSession interface.

#include <SFBMcastSession.h.hpp>

class SFBMcastSession : public SFBModel;

SFMTYPEDEFWRAPPER(SFBMcastSession)

Inheritance diagram

Version

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

Reference

BREW API IMcastSession

Member

Public Functions
`SFCError`	AddRetryCB( `SFXCallbackPtr` callback ) This function should be used by clients in order to be notified when the Join() operation should be retried.
`SFCError`	ExtFunc( `AEECLSID` id , `VoidPtr` buffer , `SInt32` size )
`SFCError`	GetGroupAddr( `VoidPtr` groupAddress , `SInt32Ptr` size ) Retrieve the multicast group address and port, if the multicast session object is currently registered to a group.
`SFCError`	Join( `VoidPtr` groupAddress ) Issue a request for joining a multicast group.
`SFCError`	JoinMBMS( `VoidPtr` groupAddress , `AEEMcast_MBMSJoinInfo *` mbmsInfo ) Issue a request for joining an MBMS multicast group.
`SFCError`	Leave( `Void` ) Issue a request for leaving a multicast group.
static `SFBMcastSessionSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBMcastSession instance.
static `SFBMcastSessionSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBMcastSession instance.
`SFCError`	SelectNetworkEx( `SInt32` network , `SInt16` family ) Select a specific data network for this multicast session.
`SFCError`	AddListener( `ModelListener*` listener ) (inherits from SFBModel) Allow objects such as widgets and UI controls to attach a listener to the given model.
`SFCError`	AddListenerEx( `ModelListener*` listener , `PFNLISTENER` notify , `VoidPtr` data ) (inherits from SFBModel) Initialize the fields of a ModelListener, and register the listener with the model.
`SFCError`	Notify( `ModelListener*` listener ) (inherits from SFBModel) send a notify event to all listeners that are currently installed on the model. The notification will be sent to the function specified by the pfnListener member of the ModelListener data structure passed to SFBModel:AddListener().
`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.

SFBMcastSession::AddRetryCB

This function should be used by clients in order to be notified when the Join() operation should be retried.

[ public ]
SFCError AddRetryCB(
    SFXCallbackPtr callback   // the client's callback
);

Reference

BREW API IMcastSession_AddRetryCB | SFBMcastSession::Join

SFBMcastSession::ExtFunc

[ public ]
SFCError ExtFunc(
    AEECLSID id      // 
    VoidPtr buffer   // 
    SInt32 size      // 
);

引数

id: ... id の説明 ...
buffer: ... buffer の説明 ...
size: ... size の説明 ...

戻り値

*** 戻り値の説明 ***

解説

*** 解説 ***

使用例

*** 使用例 ***

参照

*** 主に xref リンクを書きます ***

SFBMcastSession::GetGroupAddr

Retrieve the multicast group address and port, if the multicast session object is currently registered to a group.

[ public ]
SFCError GetGroupAddr(
    VoidPtr groupAddress   // place holder for the group to which the session is registered
    SInt32Ptr size         //  pointer to the size of the group address
);

Reference

BREW API IMcastSession_GetGroupAddr

SFBMcastSession::Join

Issue a request for joining a multicast group.

[ public ]
SFCError Join(
    VoidPtr groupAddress   // multicast group address and port to join
);

Reference

BREW API IMcastSession_Join

SFBMcastSession::JoinMBMS

Issue a request for joining an MBMS multicast group.

[ public ]
SFCError JoinMBMS(
    VoidPtr groupAddress               // multicast group address and port to join
    AEEMcast_MBMSJoinInfo * mbmsInfo   // MBMS parameters for multicast join operation
);

Version

Introduced BREW Client 4.0.2

Reference

BREW API IMcastSession_JoinMBMS | SFBMcastSession::Join

SFBMcastSession::Leave

Issue a request for leaving a multicast group.

[ public ]
SFCError Leave(Void);

Reference

BREW API IMcastSession_Leave | SFBModel::AddListener | SFBMcastSession::Join

SFBMcastSession::NewInstance

Create a new SFBMcastSession instance.

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

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

SFBMcastSession::SelectNetworkEx

Select a specific data network for this multicast session.

[ public ]
SFCError SelectNetworkEx(
    SInt32 network   // data network type (AEE_NETWORK_*)
    SInt16 family    // address family (AEE_AF_*)
);

Reference

BREW API IMcastSession_SelectNetworkEx | SFBMcastSession::Join