diff options
author | Thomas Watson | 2017-02-15 18:43:00 +0000 |
---|---|---|
committer | Thomas Watson | 2017-06-16 12:38:08 +0000 |
commit | 89617708753627e2aecdea7393d64ccf24a0b0eb (patch) | |
tree | 5e94961260e14f6ad5fcd1522eb5c254971d18e7 /bundles/org.eclipse.equinox.logstream/src/org/osgi/service/log/stream | |
parent | 5bfcf92c80bd0a88f702c5c61e644db3144da53b (diff) | |
download | rt.equinox.framework-89617708753627e2aecdea7393d64ccf24a0b0eb.tar.gz rt.equinox.framework-89617708753627e2aecdea7393d64ccf24a0b0eb.tar.xz rt.equinox.framework-89617708753627e2aecdea7393d64ccf24a0b0eb.zip |
Work in progress for log stream impl
Change-Id: I0637d29c39e8b896bf5dc863cb52c51bc18f5d53
Signed-off-by: Thomas Watson <tjwatson@us.ibm.com>
Diffstat (limited to 'bundles/org.eclipse.equinox.logstream/src/org/osgi/service/log/stream')
2 files changed, 101 insertions, 0 deletions
diff --git a/bundles/org.eclipse.equinox.logstream/src/org/osgi/service/log/stream/LogStreamProvider.java b/bundles/org.eclipse.equinox.logstream/src/org/osgi/service/log/stream/LogStreamProvider.java new file mode 100644 index 000000000..99f5645c9 --- /dev/null +++ b/bundles/org.eclipse.equinox.logstream/src/org/osgi/service/log/stream/LogStreamProvider.java @@ -0,0 +1,63 @@ +/* + * Copyright (c) OSGi Alliance (2016). All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.osgi.service.log.stream; + +import org.osgi.annotation.versioning.ProviderType; +import org.osgi.service.log.LogEntry; +import org.osgi.util.pushstream.PushStream; + +/** + * LogStreamProvider service for creating a PushStream of {@link LogEntry} + * objects. + * + * @ThreadSafe + * @author $Id$ + */ +@ProviderType +public interface LogStreamProvider { + /** + * Creation options for the PushStream of {@link LogEntry} objects. + */ + enum Options { + /** + * Include history. + * <p> + * Prime the created PushStream with the past {@link LogEntry} objects. + * The number of past {@link LogEntry} objects is implementation + * specific. + * <p> + * The created PushStream will supply the past {@link LogEntry} objects + * followed by newly created {@link LogEntry} objects. + */ + HISTORY; + } + + /** + * Create a PushStream of {@link LogEntry} objects. + * <p> + * The returned PushStream is an unbuffered stream with a parallelism of + * one. + * <p> + * When this LogStreamProvider service is released by the obtaining bundle, + * this LogStreamProvider service must call {@code close()} on the returned + * PushStream object if it has not already been closed. + * + * @param options The options to use when creating the PushStream. + * @return A PushStream of {@link LogEntry} objects. + */ + PushStream<LogEntry> createStream(Options... options); +} diff --git a/bundles/org.eclipse.equinox.logstream/src/org/osgi/service/log/stream/package-info.java b/bundles/org.eclipse.equinox.logstream/src/org/osgi/service/log/stream/package-info.java new file mode 100644 index 000000000..2e914e0b3 --- /dev/null +++ b/bundles/org.eclipse.equinox.logstream/src/org/osgi/service/log/stream/package-info.java @@ -0,0 +1,38 @@ +/* + * Copyright (c) OSGi Alliance (2016). All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Log Stream Package Version 1.0. + * <p> + * Bundles wishing to use this package must list the package in the + * Import-Package header of the bundle's manifest. This package has two types of + * users: the consumers that use the API in this package and the providers that + * implement the API in this package. + * <p> + * Example import for consumers using the API in this package: + * <p> + * {@code Import-Package: org.osgi.service.log.stream; version="[1.0,2.0)"} + * <p> + * Example import for providers implementing the API in this package: + * <p> + * {@code Import-Package: org.osgi.service.log.stream; version="[1.0,1.1)"} + * + * @author $Id$ + */ +@Version("1.0") +package org.osgi.service.log.stream; + +import org.osgi.annotation.versioning.Version; |