1 /**********************************************************************
2 * Copyright (c) 2012, 2013 Ericsson
4 * All rights reserved. This program and the accompanying materials are
5 * made available under the terms of the Eclipse Public License v1.0 which
6 * accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
10 * Bernd Hufmann - Initial API and implementation
11 * Bernd Hufmann - Updated for support of LTTng Tools 2.1
12 **********************************************************************/
13 package org
.eclipse
.linuxtools
.internal
.lttng2
.core
.control
.model
;
15 import java
.util
.List
;
19 * Interface for retrieval of trace session information.
22 * @author Bernd Hufmann
24 public interface ISessionInfo
extends ITraceInfo
{
27 * @return the session state state (active or inactive).
29 TraceSessionState
getSessionState();
31 * Sets the session state to the given value.
32 * @param state - state to set.
34 void setSessionState(TraceSessionState state
);
37 * Sets the event state to the value specified by the given name.
38 * @param stateName - state to set.
40 void setSessionState(String stateName
);
43 * @return path string where session is located.
45 String
getSessionPath();
48 * Sets the path string (where session is located) to the given value.
49 * @param path - session path to set.
51 void setSessionPath(String path
);
54 * @return all domain information as array.
56 IDomainInfo
[] getDomains();
59 * Sets all domain information specified by given list.
60 * @param domains - all domain information to set.
62 void setDomains(List
<IDomainInfo
> domains
);
65 * Adds a single domain information.
66 * @param domainInfo domain information to add.
68 void addDomain(IDomainInfo domainInfo
);
71 * Returns if session is streamed over network
72 * @return <code>true</code> if streamed over network else <code>false</code>
74 boolean isStreamedTrace();
77 * Sets whether the trace is streamed or not
78 * @param isStreamedTrace <code>true</code> if streamed over network else <code>false</code>
80 void setStreamedTrace(boolean isStreamedTrace
);
83 * Returns whether the session is snapshot session or not
84 * @return <code>true</code> if it is snapshot session else <code>false</code>
86 boolean isSnapshotSession();
89 * Gets the snapshot information the session or null if it is not a
91 * @return snapshot information
93 ISnapshotInfo
getSnapshotInfo();
96 * Sets the snapshot information of the session
97 * @param setSnapshotInfo - the snapshot data to set.
99 void setSnapshotInfo(ISnapshotInfo setSnapshotInfo
);