org.kurento.client.ServerManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kurento-client Show documentation
Kurento Client The Kurento Client project allows server applications to control media server resources.
There is a newer version: 7.1.0
/**
 * This file is generated with Kurento-maven-plugin.
 * Please don't edit.
 */
package org.kurento.client;


/**
 *
 * This is a standalone object for managing the MediaServer
 *
 **/
@org.kurento.client.internal.RemoteClass
public interface ServerManager extends MediaObject {

/**
 *
 * Get Server information, version, modules, factories, etc
 *
 **/
     org.kurento.client.ServerInfo getInfo();

/**
 *
 * Get Server information, version, modules, factories, etc
 *
 **/
     void getInfo(Continuation cont);

/**
 *
 * Get Server information, version, modules, factories, etc
 *
 **/
     TFuture getInfo(Transaction tx);

/**
 *
 * Get All the pipelines available in the server
 *
 **/
     java.util.List getPipelines();

/**
 *
 * Get All the pipelines available in the server
 *
 **/
     void getPipelines(Continuation> cont);

/**
 *
 * Get All the pipelines available in the server
 *
 **/
     TFuture> getPipelines(Transaction tx);

/**
 *
 * Get All active sessions in the server
 *
 **/
     java.util.List getSessions();

/**
 *
 * Get All active sessions in the server
 *
 **/
     void getSessions(Continuation> cont);

/**
 *
 * Get All active sessions in the server
 *
 **/
     TFuture> getSessions(Transaction tx);

/**
 *
 * Get Metadata stored in the server
 *
 **/
     String getMetadata();

/**
 *
 * Get Metadata stored in the server
 *
 **/
     void getMetadata(Continuation cont);

/**
 *
 * Get Metadata stored in the server
 *
 **/
     TFuture getMetadata(Transaction tx);



/**
 *
 * Returns the kmd associated to a module
 *
 * @param moduleName
 *       Name of the module to get its kmd file
 * @return The kmd file *
 **/
  String getKmd(@org.kurento.client.internal.server.Param("moduleName") String moduleName);

/**
 *
 * Asynchronous version of getKmd:
 * {@link Continuation#onSuccess} is called when the action is
 * done. If an error occurs, {@link Continuation#onError} is called.
 * @see ServerManager#getKmd
 *
 * @param moduleName
 *       Name of the module to get its kmd file
 *
 **/
    void getKmd(@org.kurento.client.internal.server.Param("moduleName") String moduleName, Continuation cont);

/**
 *
 * Returns the kmd associated to a module
 *
 * @param moduleName
 *       Name of the module to get its kmd file
 * @return The kmd file *
 **/
    TFuture getKmd(Transaction tx, @org.kurento.client.internal.server.Param("moduleName") String moduleName);


/**
 *
 * Returns the amount of memory that the server is using in KiB
 * @return The amount of KiB of memory being used *
 **/
  long getUsedMemory();

/**
 *
 * Asynchronous version of getUsedMemory:
 * {@link Continuation#onSuccess} is called when the action is
 * done. If an error occurs, {@link Continuation#onError} is called.
 * @see ServerManager#getUsedMemory
 *
 **/
    void getUsedMemory(Continuation cont);

/**
 *
 * Returns the amount of memory that the server is using in KiB
 * @return The amount of KiB of memory being used *
 **/
    TFuture getUsedMemory(Transaction tx);

    /**
     * Add a {@link EventListener} for event {@link ObjectCreatedEvent}. Synchronous call.
     *
     * @param  listener Listener to be called on ObjectCreatedEvent
     * @return ListenerSubscription for the given Listener
     *
     **/
    @org.kurento.client.internal.server.EventSubscription(ObjectCreatedEvent.class)
    ListenerSubscription addObjectCreatedListener(EventListener listener);
    /**
     * Add a {@link EventListener} for event {@link ObjectCreatedEvent}. Asynchronous call.
     * Calls Continuation<ListenerSubscription> when it has been added.
     *
     * @param listener Listener to be called on ObjectCreatedEvent
     * @param cont     Continuation to be called when the listener is registered
     *
     **/
    @org.kurento.client.internal.server.EventSubscription(ObjectCreatedEvent.class)
    void addObjectCreatedListener(EventListener listener, Continuation cont);
    
	/**
     * Remove a {@link ListenerSubscription} for event {@link ObjectCreatedEvent}. Synchronous call.
     *
     * @param listenerSubscription Listener subscription to be removed
     *
     **/
    @org.kurento.client.internal.server.EventSubscription(ObjectCreatedEvent.class)
    void removeObjectCreatedListener(ListenerSubscription listenerSubscription);
    /**
     * Remove a {@link ListenerSubscription} for event {@link ObjectCreatedEvent}. Asynchronous call.
     * Calls Continuation<Void> when it has been removed.
     *
     * @param listenerSubscription Listener subscription to be removed
     * @param cont                 Continuation to be called when the listener is removed
     *
     **/
    @org.kurento.client.internal.server.EventSubscription(ObjectCreatedEvent.class)
    void removeObjectCreatedListener(ListenerSubscription listenerSubscription, Continuation cont);
    /**
     * Add a {@link EventListener} for event {@link ObjectDestroyedEvent}. Synchronous call.
     *
     * @param  listener Listener to be called on ObjectDestroyedEvent
     * @return ListenerSubscription for the given Listener
     *
     **/
    @org.kurento.client.internal.server.EventSubscription(ObjectDestroyedEvent.class)
    ListenerSubscription addObjectDestroyedListener(EventListener listener);
    /**
     * Add a {@link EventListener} for event {@link ObjectDestroyedEvent}. Asynchronous call.
     * Calls Continuation<ListenerSubscription> when it has been added.
     *
     * @param listener Listener to be called on ObjectDestroyedEvent
     * @param cont     Continuation to be called when the listener is registered
     *
     **/
    @org.kurento.client.internal.server.EventSubscription(ObjectDestroyedEvent.class)
    void addObjectDestroyedListener(EventListener listener, Continuation cont);
    
	/**
     * Remove a {@link ListenerSubscription} for event {@link ObjectDestroyedEvent}. Synchronous call.
     *
     * @param listenerSubscription Listener subscription to be removed
     *
     **/
    @org.kurento.client.internal.server.EventSubscription(ObjectDestroyedEvent.class)
    void removeObjectDestroyedListener(ListenerSubscription listenerSubscription);
    /**
     * Remove a {@link ListenerSubscription} for event {@link ObjectDestroyedEvent}. Asynchronous call.
     * Calls Continuation<Void> when it has been removed.
     *
     * @param listenerSubscription Listener subscription to be removed
     * @param cont                 Continuation to be called when the listener is removed
     *
     **/
    @org.kurento.client.internal.server.EventSubscription(ObjectDestroyedEvent.class)
    void removeObjectDestroyedListener(ListenerSubscription listenerSubscription, Continuation cont);
    




}