ProfilingConnectionFactory Class Reference

#include <ProfilingConnectionFactory.hpp>

Inheritance diagram for ProfilingConnectionFactory:

Public Member Functions
	ProfilingConnectionFactory ()=default
	~ProfilingConnectionFactory ()=default
IProfilingConnectionPtr	GetProfilingConnection (const ExternalProfilingOptions &options) const override
Public Member Functions inherited from IProfilingConnectionFactory
virtual	~IProfilingConnectionFactory ()

Additional Inherited Members
Public Types inherited from IProfilingConnectionFactory
using	ExternalProfilingOptions = IRuntime::CreationOptions::ExternalProfilingOptions
using	IProfilingConnectionPtr = std::unique_ptr< IProfilingConnection >

Detailed Description

Definition at line 16 of file ProfilingConnectionFactory.hpp.

Constructor & Destructor Documentation

ProfilingConnectionFactory()

ProfilingConnectionFactory ( )

default

~ProfilingConnectionFactory()

~ProfilingConnectionFactory ( )

default

Member Function Documentation

GetProfilingConnection()

std::unique_ptr< IProfilingConnection > GetProfilingConnection ( const ExternalProfilingOptions &  options ) const

overridevirtual

Implements IProfilingConnectionFactory.

Definition at line 18 of file ProfilingConnectionFactory.cpp.

References IRuntime::CreationOptions::ExternalProfilingOptions::m_FileFormat, IRuntime::CreationOptions::ExternalProfilingOptions::m_FileOnly, IRuntime::CreationOptions::ExternalProfilingOptions::m_IncomingCaptureFile, IRuntime::CreationOptions::ExternalProfilingOptions::m_LocalPacketHandlers, and IRuntime::CreationOptions::ExternalProfilingOptions::m_OutgoingCaptureFile.

{
    // Before proceed to create the IProfilingConnection, check if the file format is supported
    if (!(options.m_FileFormat == "binary"))
    {
        throw armnn::UnimplementedException("Unsupported profiling file format, only binary is supported");
    }

    // We can create 3 different types of IProfilingConnection.
    // 1: If no relevant options are specified then a SocketProfilingConnection is returned.
    // 2: If both incoming and outgoing capture files are specified then a SocketProfilingConnection decorated by a
    //    ProfilingConnectionDumpToFileDecorator is returned.
    // 3: If both incoming and outgoing capture files are specified and "file only" then a FileOnlyProfilingConnection
    //    decorated by a ProfilingConnectionDumpToFileDecorator is returned.
    // 4. There is now another option if m_FileOnly == true and there are ILocalPacketHandlers specified
    //    we can create a FileOnlyProfilingConnection without a file dump
    if ((!options.m_IncomingCaptureFile.empty() || !options.m_OutgoingCaptureFile.empty()) && !options.m_FileOnly)
    {
        // This is type 2.
        return std::make_unique<ProfilingConnectionDumpToFileDecorator>(std::make_unique<SocketProfilingConnection>(),
                                                                        options);
    }
    else if ((!options.m_IncomingCaptureFile.empty() || !options.m_OutgoingCaptureFile.empty()) && options.m_FileOnly)
    {
        // This is type 3.
        return std::make_unique<ProfilingConnectionDumpToFileDecorator>(
            std::make_unique<FileOnlyProfilingConnection>(options), options);
    }
    else if (options.m_FileOnly && !options.m_LocalPacketHandlers.empty())
    {
        // This is the type 4.
        return std::make_unique<FileOnlyProfilingConnection>(options);
    }
    else
    {
        // This is type 1.
        return std::make_unique<SocketProfilingConnection>();
    }
}

---

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

• src/profiling/ProfilingConnectionFactory.hpp
• src/profiling/ProfilingConnectionFactory.cpp