trait Simple extends IOApp
A simplified version of IOApp for applications which ignore their process arguments and always produces ExitCode.Success (unless terminated exceptionally or interrupted).
- Source
- IOApp.scala
- See also
- Alphabetic
- By Inheritance
- Simple
- IOApp
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
computeWorkerThreadCount: Int
Controls the number of worker threads which will be allocated to the compute pool in the underlying runtime.
Controls the number of worker threads which will be allocated to the compute pool in the underlying runtime. In general, this should be no greater than the number of physical threads made available by the underlying kernel (which can be determined using
Runtime.getRuntime().availableProcessors()
). For any application which has significant additional non-compute thread utilization (such as asynchronous I/O worker threads), it may be optimal to reduce the number of compute threads by the corresponding amount such that the total number of active threads exactly matches the number of underlying physical threads.In practice, tuning this parameter is unlikely to affect your application performance beyond a few percentage points, and the default value is optimal (or close to optimal) in most common scenarios.
This setting is JVM-specific and will not compile on JavaScript.
For more details on Cats Effect's runtime threading model please see https://typelevel.org/cats-effect/docs/thread-model.
- Attributes
- protected
- Definition Classes
- IOApp
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
main(args: Array[String]): Unit
- Definition Classes
- IOApp
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
run(args: List[String]): IO[ExitCode]
The entry point for your application.
The entry point for your application. Will be called by the runtime when the process is started. If the underlying runtime supports it, any arguments passed to the process will be made available in the
args
parameter. The numeric value within the resulting ExitCode will be used as the exit code when the process terminates unless terminated exceptionally or by interrupt.- args
The arguments passed to the process, if supported by the underlying runtime. For example,
java com.company.MyApp --foo --bar baz
ornode com-mycompany-fastopt.js --foo --bar baz
would each result inList("--foo", "--bar", "baz")
.
-
def
runtime: IORuntime
The runtime which will be used by
IOApp
to evaluate the IO produced by therun
method.The runtime which will be used by
IOApp
to evaluate the IO produced by therun
method. This may be overridden byIOApp
implementations which have extremely specialized needs, but this is highly unlikely to ever be truly needed. As an example, if an application wishes to make use of an alternative compute thread pool (such asExecutors.fixedThreadPool
), it is almost always better to leverage IO.evalOn on the value produced by therun
method, rather than directly overridingruntime
.In other words, this method is made available to users, but its use is strongly discouraged in favor of other, more precise solutions to specific use-cases.
This value is guaranteed to be equal to unsafe.IORuntime.global.
- Attributes
- protected
- Definition Classes
- IOApp
-
def
runtimeConfig: IORuntimeConfig
The configuration used to initialize the runtime which will evaluate the IO produced by
run
. -
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()