1 /* ------------------------------------------------------------------ 2 * Copyright (C) 1998-2009 PacketVideo 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either 13 * express or implied. 14 * See the License for the specific language governing permissions 15 * and limitations under the License. 16 * ------------------------------------------------------------------- 17 */ 18 #ifndef PVMF_SOCKET_NODE_FACTORY_H_INCLUDED 19 #define PVMF_SOCKET_NODE_FACTORY_H_INCLUDED 20 21 #ifndef OSCL_BASE_H_INCLUDED 22 #include "oscl_base.h" 23 #endif 24 25 #ifndef OSCL_SCHEDULER_AO_H_INCLUDED 26 #include "oscl_scheduler_ao.h" 27 #endif 28 29 // Forward declaration 30 class PVMFNodeInterface; 31 32 /** 33 * PVMFSocketNodeFactory Class 34 * 35 * PVMFSocketNodeFactory class is a singleton class which instantiates and provides 36 * access to PVMF socket node. It returns a PVMFNodeInterface 37 * reference, the interface class of the PVMFSocketNode. 38 * 39 * The client is expected to contain and maintain a pointer to the instance created 40 * while the node is active. 41 */ 42 class PVMFSocketNodeFactory 43 { 44 public: 45 /** 46 * Creates an instance of a PVMFSocketNode. If the creation fails, this function will leave. 47 * 48 * @param aPriority The active object priority for the node. Default is standard priority if not specified 49 * @returns A pointer to an instance of PVMFSocketNode as PVMFNodeInterface reference or leaves if instantiation fails 50 **/ 51 OSCL_IMPORT_REF static PVMFNodeInterface* CreatePVMFSocketNode(int32 aPriority = OsclActiveObject::EPriorityNominal); 52 53 /** 54 * Deletes an instance of PVMFSocketNode 55 * and reclaims all allocated resources. An instance can be deleted only in 56 * the idle state. An attempt to delete in any other state will fail and return false. 57 * 58 * @param aNode The PVMFSocketNode instance to be deleted 59 * @returns A status code indicating success or failure of deletion 60 **/ 61 OSCL_IMPORT_REF static bool DeletePVMFSocketNode(PVMFNodeInterface* aNode); 62 }; 63 64 #endif // PVMF_SOCKET_NODE_FACTORY_H_INCLUDED 65