Skip to content

Commit 45b2b9d

Browse files
AnsMelanieAnsMelanie
authored
Merge pull request #247 from ansys/nicolas_millan/speos_special_version_modifications_clean
speos_special_version_modifications_clean
2 parents 0f4934d + f365905 commit 45b2b9d

File tree

19 files changed

+31318
-0
lines changed

19 files changed

+31318
-0
lines changed

‎2025R1_SP1/speos_rpc-25-r1-sp1/index.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,32 @@ The option --help is available to know more about possible arguments, and also t
8282
./SpeosRPC_Server.exe --help
8383
```
8484

85+
SpeosRPC_Server supports several secure transport protocols. Here are examples to start the server:
86+
87+
- mutual TLS transport protocol
88+
89+
```bash
90+
./SpeosRPC_Server.exe --transport_tls <SERVER_KEY>,<SERVER_CERTIFICATE>,<SERVER_CLIENT_CA> # Start server with TLS transport
91+
```
92+
93+
- Unix Domain Socket transport protocol
94+
95+
```bash
96+
./SpeosRPC_Server.exe --transport_uds <UDSPATH> # Start server with Unix Domain Socket transport
97+
```
98+
99+
- Windows Named User Authentication transport protocol
100+
101+
```bash
102+
./SpeosRPC_Server.exe --transport_wnua # Start server with Windows user-based authentication transport
103+
```
104+
105+
- Insecure transport protocol (not recommended)
106+
107+
```bash
108+
./SpeosRPC_Server.exe --transport_insecure # Start server with insecure transport (not recommended)
109+
```
110+
85111
Example of how to properly shutdown a server started on port 50053:
86112

87113
```bash

‎2025R2/speos_rpc-25-r2/index.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,32 @@ The option --help is available to know more about possible arguments, and also t
8282
./SpeosRPC_Server.exe --help
8383
```
8484

85+
SpeosRPC_Server supports several secure transport protocols. Here are examples to start the server:
86+
87+
- mutual TLS transport protocol
88+
89+
```bash
90+
./SpeosRPC_Server.exe --transport_tls <SERVER_KEY>,<SERVER_CERTIFICATE>,<SERVER_CLIENT_CA> # Start server with TLS transport
91+
```
92+
93+
- Unix Domain Socket transport protocol
94+
95+
```bash
96+
./SpeosRPC_Server.exe --transport_uds <UDSPATH> # Start server with Unix Domain Socket transport
97+
```
98+
99+
- Windows Named User Authentication transport protocol
100+
101+
```bash
102+
./SpeosRPC_Server.exe --transport_wnua # Start server with Windows user-based authentication transport
103+
```
104+
105+
- Insecure transport protocol (not recommended)
106+
107+
```bash
108+
./SpeosRPC_Server.exe --transport_insecure # Start server with insecure transport (not recommended)
109+
```
110+
85111
Example of how to properly shutdown a server started on port 50053:
86112

87113
```bash

‎2025R2_SP1/speos_rpc-25-r2-sp1/index.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,32 @@ The option --help is available to know more about possible arguments, and also t
8282
./SpeosRPC_Server.exe --help
8383
```
8484

85+
SpeosRPC_Server supports several secure transport protocols. Here are examples to start the server:
86+
87+
- mutual TLS transport protocol
88+
89+
```bash
90+
./SpeosRPC_Server.exe --transport_tls <SERVER_KEY>,<SERVER_CERTIFICATE>,<SERVER_CLIENT_CA> # Start server with TLS transport
91+
```
92+
93+
- Unix Domain Socket transport protocol
94+
95+
```bash
96+
./SpeosRPC_Server.exe --transport_uds <UDSPATH> # Start server with Unix Domain Socket transport
97+
```
98+
99+
- Windows Named User Authentication transport protocol
100+
101+
```bash
102+
./SpeosRPC_Server.exe --transport_wnua # Start server with Windows user-based authentication transport
103+
```
104+
105+
- Insecure transport protocol (not recommended)
106+
107+
```bash
108+
./SpeosRPC_Server.exe --transport_insecure # Start server with insecure transport (not recommended)
109+
```
110+
85111
Example of how to properly shutdown a server started on port 50053:
86112

87113
```bash

‎2025R2_SP3/speos_rpc-25-r2-sp3/GenDocu-template.tmpl‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# Reference documentation
2+
3+
4+
{{range .Files}}
5+
{{$short_name := .Name | replace "ansys/api/speos/" ""}} <!-- Remove base directory -->
6+
<a name="{{.Name | anchor}}"></a>
7+
8+
9+
## {{$short_name}} <!-- Use the cleaned file name here -->
10+
{{.Description}}
11+
12+
{{range .Messages}}
13+
<a name="{{.FullName | anchor}}"></a>
14+
15+
### {{.LongName}}
16+
{{.Description}}
17+
18+
{{if .HasFields}}
19+
| Field | Type | Label | Description |
20+
| ----- | ---- | ----- | ----------- |
21+
{{range .Fields -}}
22+
| {{.Name}} | [{{.LongType | replace "ansys.api.speos." ""}}](#{{.FullType | anchor}}) | {{.Label}} | {{if (index .Options "deprecated"|default false)}}**Deprecated.** {{end}}{{.Description | replace "\n" "<br>" | nobr}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} |
23+
{{end}}
24+
{{end}}
25+
26+
{{if .HasExtensions}}
27+
| Extension | Type | Base | Number | Description |
28+
| --------- | ---- | ---- | ------ | ----------- |
29+
{{range .Extensions -}}
30+
| {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} |
31+
{{end}}
32+
{{end}}
33+
34+
{{end}} <!-- end messages -->
35+
36+
{{range .Enums}}
37+
<a name="{{.FullName | anchor}}"></a>
38+
39+
### {{.LongName}}
40+
{{.Description}}
41+
42+
| Name | Number | Description |
43+
| ---- | ------ | ----------- |
44+
{{range .Values -}}
45+
| {{.Name}} | {{.Number}} | {{nobr .Description}} |
46+
{{end}}
47+
48+
{{end}} <!-- end enums -->
49+
50+
{{if .HasExtensions}}
51+
<a name="{{$short_name | anchor}}-extensions"></a>
52+
53+
### File-level Extensions
54+
| Extension | Type | Base | Number | Description |
55+
| --------- | ---- | ---- | ------ | ----------- |
56+
{{range .Extensions -}}
57+
| {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: `{{.DefaultValue}}`{{end}} |
58+
{{end}}
59+
{{end}} <!-- end HasExtensions -->
60+
61+
{{range .Services}}
62+
<a name="{{.FullName | anchor}}"></a>
63+
64+
### {{.Name}}
65+
{{.Description}}
66+
67+
| Method Name | Request Type | Response Type | Description |
68+
| ----------- | ------------ | ------------- | ------------|
69+
{{range .Methods -}}
70+
| {{.Name}} | [{{.RequestLongType | replace ".ansys.api.speos." "" | replace "ansys.api.speos." ""}}](#{{.RequestFullType | anchor}}){{if .RequestStreaming}} stream{{end}} | [{{.ResponseLongType | replace ".ansys.api.speos." "" | replace "ansys.api.speos." ""}}](#{{.ResponseFullType | anchor}}){{if .ResponseStreaming}} stream{{end}} | {{nobr .Description}} |
71+
{{end}}
72+
{{end}} <!-- end services -->
73+
74+
{{end}}
75+
76+
## Scalar Value Types
77+
78+
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
79+
| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- |
80+
{{range .Scalars -}}
81+
| <a name="{{.ProtoType | anchor}}" /> {{.ProtoType}} | {{.Notes}} | {{.CppType}} | {{.JavaType}} | {{.PythonType}} | {{.GoType}} | {{.CSharp}} | {{.PhpType}} | {{.RubyType}} |
82+
{{end}}

‎2025R2_SP3/speos_rpc-25-r2-sp3/TOC.yml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
- name: Introduction
2+
href: index.md
3+
- name: Unsupported features and limitations
4+
href: unsupported-features-limitations.md
5+
- name: Reference documentation
6+
href: api-reference.md
7+
- name: Changelog
8+
href: changelogs\speos_changelogs_rpc.md
9+
items:
10+
- name: Speos RPC Changelog 2025 R2
11+
href: changelogs\speos_changelogs_rpc_252.md
12+
- name: Speos RPC Changelog 2025 R2 SP1
13+
href: changelogs\speos_changelogs_rpc_2521.md

0 commit comments

Comments
 (0)