package
1.0.0
Repository: https://github.com/jamespfennell/transiter.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
No description provided by the author
RegisterAdminHandler registers the http handlers for service Admin to "mux".
RegisterAdminHandlerClient registers the http handlers for service Admin to "mux".
RegisterAdminHandlerFromEndpoint is same as RegisterAdminHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterAdminHandlerServer registers the http handlers for service Admin to "mux".
No description provided by the author
RegisterPublicHandler registers the http handlers for service Public to "mux".
RegisterPublicHandlerClient registers the http handlers for service Public to "mux".
RegisterPublicHandlerFromEndpoint is same as RegisterPublicHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterPublicHandlerServer registers the http handlers for service Public to "mux".
No description provided by the author

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Perform an update once a day, with the time of day specified in the `daily_update_time` field.
Use the default policy, which is PERIODIC for GTFS realtime feeds and DAILY for all other feeds.
Don't perform updates in the scheduler.
Perform an update periodically, with the period specified in the `periodic_update_period_ms` field.
Failed to download feed data.
Feed data was empty.
An internal unspecified error occured.
The feed configuration is invalid.
Failed to parse the feed data.
The feed has an unknown type.
Failed to update the database using the new feed data.
Feed update is in progress.
The update was skipped because the downloaded data was identical to the data for the last successful update.
Unknown status.
Finished successfully.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Return all stops within max_distance of (latitude, longitude), sorted by the distance.
Return a paginated list of stops sorted by stop ID.
Return all vehicles within max_distance of (latitude, longitude), sorted by the distance.
Return a paginated list of vehicles sorted by vehicle ID.
No description provided by the author
Continuous pickup or drop-off allowed.
No description provided by the author
No description provided by the author
Must coordinate with driver to arrange continuous pickup or drop-off.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Continuous pickup or drop-off not allowed.
Must phone the agency to arrange continuous pickup or drop-off.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Build the service maps using the GTFS realtime data.
Build the service maps using the GTFS static data.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The system was successfully installed and is now active.
The system is in the process of being deleted through an asynchronous delete request.
The system was added through an asynchronous install request, but the install failed.
The system is currently being installed through an asychronous install request.
Unknown status, included for protobuf reasons.
An asynchronous update of the system failed.
The system is currently being updated through an asynchronous update request.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

Admin_ServiceDesc is the grpc.ServiceDesc for Admin service.
Enum value maps for Alert_Cause.
Enum value maps for Alert_Cause.
Enum value maps for Alert_Effect.
Enum value maps for Alert_Effect.
Enum value maps for FeedConfig_SchedulingPolicy.
Enum value maps for FeedConfig_SchedulingPolicy.
Enum value maps for FeedUpdate_Status.
Enum value maps for FeedUpdate_Status.
No description provided by the author
No description provided by the author
Enum value maps for GtfsRealtimeOptions_Extension.
Enum value maps for GtfsRealtimeOptions_Extension.
Enum value maps for GtfsRealtimeOptions_NyctAlertsOptions_ElevatorAlertsDeduplicationPolicy.
Enum value maps for GtfsRealtimeOptions_NyctAlertsOptions_ElevatorAlertsDeduplicationPolicy.
Enum value maps for ListStopsRequest_SearchMode.
Enum value maps for ListStopsRequest_SearchMode.
Enum value maps for ListVehiclesRequest_SearchMode.
Enum value maps for ListVehiclesRequest_SearchMode.
Public_ServiceDesc is the grpc.ServiceDesc for Public service.
Enum value maps for Route_ContinuousPolicy.
Enum value maps for Route_ContinuousPolicy.
Enum value maps for Route_Type.
Enum value maps for Route_Type.
Enum value maps for ServiceMapConfig_Source.
Enum value maps for ServiceMapConfig_Source.
Enum value maps for Stop_Type.
Enum value maps for Stop_Type.
Enum value maps for System_Status.
Enum value maps for System_Status.
Enum value maps for Transfer_Type.
Enum value maps for Transfer_Type.
Enum value maps for Vehicle_CongestionLevel.
Enum value maps for Vehicle_CongestionLevel.
Enum value maps for Vehicle_CurrentStatus.
Enum value maps for Vehicle_CurrentStatus.
Enum value maps for Vehicle_OccupancyStatus.
Enum value maps for Vehicle_OccupancyStatus.

# Structs

The Agency resource.
Reference is the reference type for the agency resource.
The Alert resource.
The active period message describes a period when an alert is active.
Reference is the reference type for the agency resource.
The text message describes an alert header/description/URL in a specified language.
Description of a collection of child resources for a resource.
No description provided by the author
No description provided by the author
Response payload for the entrypoint endpoint.
Message containing version information about a Transiter binary.
Message containing information about a specific Transiter CI build.
Request payload for the entrypoint endpoint.
The feed resource.
Reference is the reference type for the feed resource.
No description provided by the author
Description of a feed update operation.
Request payload for the get agency endpoint.
Request payload for the get alert endpoint.
Request payload for the get feed endpoint.
No description provided by the author
No description provided by the author
Request payload for the get route endpoint.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Reqeust payload for the get stop endpoint.
No description provided by the author
Request payload for the get system endpoint.
Request payload for the get trip endpoint.
No description provided by the author
Message describing additional options for the GTFS realtime feeds.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Response payload for the list agencies endpoint.
Request payload for the list agencies endpoint.
Response payload for the list alerts endpoiont.
Request payload for the list alerts endpoint.
Response payload for the list feeds endpoint.
Request payload for the list feeds endpoint.
Response payload for the list routes endpoint.
Request payload for the list routes endpoint.
No description provided by the author
No description provided by the author
Response payload for the list stops endpoint.
Request payload for the list stops endpoint.
Response payload for the list systems endpoint.
Request payload for the list systems endpoint.
Response payload for the list transfers endpoint.
Request payload for the list transfers endpoint.
Response payload for the list trips endpoint.
Request payload for the list trips endpoint.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The resource message contains generic metadata that applies to all resources.
The Route resource.
Reference is the reference type for the route resource.
Message describing the service maps view in routes.
Description of the configuration for a collection of service maps.
Description of options relevent for static service maps only.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A point within the shape.
The Stop resource.
Message describing a headsign rule.
Reference is the reference type for the stop resource.
Message describing the service maps view in stops.
Message describing a realtime stop time.
Message describing the arrival or departure time of a stop time.
The System resource.
Reference is the reference type for the system resource.
Configuration for a system.
No description provided by the author
No description provided by the author
Reference is the reference type for the trip resource.
UnimplementedAdminServer should be embedded to have forward compatible implementations.
UnimplementedPublicServer should be embedded to have forward compatible implementations.
No description provided by the author
No description provided by the author
The Vehicle resource.
Reference is the reference type for the vehicle resource.
YamlConfig contains a Transiter system configuration in YAML format.

# Interfaces

AdminClient is the client API for Admin service.
AdminServer is the server API for Admin service.
PublicClient is the client API for Public service.
PublicServer is the server API for Public service.
UnsafeAdminServer may be embedded to opt out of forward compatibility for this service.
UnsafePublicServer may be embedded to opt out of forward compatibility for this service.

# Type aliases

Cause is the same as the [cause enum in the GTFS realtime specification](https://gtfs.org/realtime/feed-entities/service-alerts/#cause), except `UNKNOWN_CAUSE` has value 0 instead of 1 to satisfy proto3 requirements.
Effect is the same as the [effect enum in the GTFS realtime specification](https://gtfs.org/realtime/feed-entities/service-alerts/#effect), except `UNKNOWN_EFFECT` has value 0 instead of 1 to satisfy proto3 requirements.
Transiter runs a background task called the scheduler which performs feed updates automatically.
No description provided by the author
No description provided by the author
No description provided by the author
The possible search modes when listing stops.
No description provided by the author
Enum describing possible policies for continuous pickup or drop-off.
Enum describing possible route types.
Source describes the possible sources for service maps.
Enum describing the possible stop types.
Enum describing the possible statuses of a system.
No description provided by the author
Corresponds to [CongestionLevel](https://gtfs.org/realtime/reference/ #enum-congestionlevel).
Corresponds to [VehicleStopStatus](https://gtfs.org/realtime/reference/ #enum-vehiclestopstatus).
Corresponds to [OccupancyStatus](https://gtfs.org/realtime/reference/ #enum-occupancystatus).